Script documentation generation and UML support (#992)

Documentation is now generated by invoking a shell script
which takes care of all the plumbing.
There is now also support of inlineing PlantUML syntax with
Doxygen. This inlining takes the form of
@startuml{imagename.png}
'PlantUML specific syntax'
@enduml
The inlineing can be made in C syntax comment blocks.
Doxygen will then include the generated UML diagram when
rendering the HTML documentation.
All generated images will be placed under Documentation/img
which is the default search path for Doxygen.
This commit is contained in:
Patrick Fallberg
2017-11-16 22:21:01 +01:00
committed by Mikael Falkvidd
parent 1f8d810ff4
commit 356b783e19
6 changed files with 39 additions and 18 deletions
+2 -15
View File
@@ -1,22 +1,9 @@
#!groovy
def call(config) {
config.pr.setBuildStatus(config, 'PENDING', 'Toll gate (Documentation)', 'Generating...', '${BUILD_URL}flowGraphTable/')
// Generate doxygen file for Raspberry Pi configure command
sh """#!/bin/bash +x
sh """#!/bin/bash
cd ${config.repository_root}
echo -e "/**\n * @defgroup RaspberryPiGateway Raspberry Pi Gateway\n * @ingroup MyConfigGrp\n * @brief Configuration options for the Raspberry Pi Gateway\n@{\n@verbatim" > configure.h
grep -A999 '<<EOF' configure | grep -B999 EOF | grep -v 'EOF' >> configure.h
echo -e "@endverbatim\n@}*/\n" >> configure.h"""
sh """#!/bin/bash +x
cd ${config.repository_root}
export PROJECTNUMBER=\$(
if [[ \$(git rev-parse --abbrev-ref HEAD) == "master" ]]; then
git describe --tags ;
else
git rev-parse --short HEAD ;
fi
)
echo 'WARN_LOGFILE=doxygen.log' >> Doxyfile && doxygen"""
Documentation/doxygen.sh"""
warnings canComputeNew: false, canResolveRelativePaths: false,
defaultEncoding: '',
excludePattern: '''.*/sha204_library\\.h,.*/drivers/Linux/.*,.*/cores/esp8266/.*,hardware/.*''',