* Find a local plantuml installation
Search the usual location for the jar file and use it instead.
It will work for debian/ubuntu, fedora and arch.
* Nicer layout for the dev-env readme
* Optional tools to make the docs
What's needed to generate the documentation.
How to run it.
* plantuml.jar removed
No need to keep a local copy of the jar-file.
doxygen.sh will find a version, if installed from the package manager.
* Added homebrew support for plantuml
* Clarify that MY_HOSTNAME is only supported on ESP
And remove redundant Doxygen define, that caused MY_HOSTNAME
to show up twice in the documentation.
* Fix double define of MY_RAM_ROUTING_TABLE_ENABLED
MY_RAM_ROUTING_TABLE_ENABLED showed up twice in the docs.
By reordering, the define only shows up once.
I don't think DOXYGEN will be defined when anyone builds their
sketches, so this change should not affect functionality.
* Doxygen: Add check for multiple defines of same keyword
* Fix unmatched ifdef
* Add documentation for config struct for Linux gw
This avoids the following doxygen warning:
warning: Compound config is not documented.
* Added getSleepRemaining to core
* Test plantuml
* Initial transport statechart
* Fixed spaces at line endings
* Fix render as class
* Plantuml update
* Update MyTransport.h
* Let Gitler produce a changelog for release builds
* Fix bug in publishing release documentation
* Fix bug in labeling documentation
(now uses tag data for better tracability)
* Update copyright in documentation
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.
Project named "MySensors Library & Examples"
Index root is libraries/MySensors with recursive search
No LaTeX generation
Documentation/html added to .gitignore