Commit Graph

23 Commits

Author SHA1 Message Date
Olivier
8eea242512 Prepare 2.4.0 release (#1587) 2026-01-01 11:36:35 +01:00
rstephan
93db0e1e68 Removed local plantuml.jar file (#1467)
* 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
2025-11-17 17:56:06 +02:00
Olivier
0b94c2dc1a Update comments (#1574) 2025-11-17 17:29:49 +02:00
Mikael Falkvidd
347ca0a43a Update docs (#1428)
* 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.
2020-06-06 09:45:13 +02:00
Yveaux
42a7456541 Transport doc (#1291)
* Added getSleepRemaining to core
* Test plantuml
* Initial transport statechart
* Fixed spaces at line endings
* Fix render as class
* Plantuml update
* Update MyTransport.h
2019-05-27 22:06:51 +02:00
tekka
71b06987ab Code maintenance (#1261) 2019-01-27 20:58:06 +01:00
tekka
6ffe29cb5f Code maintenance (#1186) 2018-08-22 20:50:16 +02:00
Mikael Falkvidd
7a33082eaf Simplify doxygen for ./configure (#1080)
No need to grep when we have a command that outputs
exactly what we want.
2018-03-12 11:47:39 +01:00
Patrick Fallberg
968b2daff7 Various CI-pipeline fixes (#1042)
* 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
2018-02-10 20:43:18 +01:00
tekka
1feae06d7f SignalReport disabled by default (#1027) 2018-01-11 07:46:43 +01:00
Patrick Fallberg
356b783e19 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.
2017-11-16 22:21:01 +01:00
Patrick Fallberg
f3ab329ad3 Refactor the Doxygen structure (#880) 2017-07-31 18:42:26 +02:00
Patrick Fallberg
ea65c5b150 Move Doxyfile to repository root (#674)
This makes most tools/plugins for Doxygen work without
much adjustment.
Also resolved some Doxygen warnings.
2016-11-29 11:18:49 +01:00
Thomas Mørch
ba6bb915c2 Reorganizing library structure, prep for 2.0.0 2016-07-09 21:17:37 +02:00
Patrick Fallberg
68e8c2438e Better output directory handling in doxygen 2015-12-11 12:35:18 +01:00
Patrick Fallberg
5142cdc936 Documentation styling made a bit more "MySensorish" 2015-12-11 00:40:03 +01:00
Patrick Fallberg
6bfe853709 Added doc default style templates and activated graphing 2015-12-11 00:40:03 +01:00
Patrick Fallberg
941503b24f Divided public and private/internal modules
Public modules can be declared as normal. Internal modules should
have @ingroup internals after the group definition.
2015-12-11 00:40:03 +01:00
Patrick Fallberg
f34ed5466e Added documentation extension mapping for INO files 2015-12-11 00:40:03 +01:00
Patrick Fallberg
9f0a348fbf Removed obsolete Doxyfile tags 2015-12-11 00:40:02 +01:00
Patrick Fallberg
9d7a2fd6e3 Documented signing related functionality 2015-12-11 00:40:02 +01:00
Patrick Fallberg
cc544909ce Doxygen warnings cleanup
But made sure that any undocumented parts generates a warning
2015-12-11 00:40:02 +01:00
Patrick Fallberg
e9971285a5 Initial Doxyfile commit
Project named "MySensors Library & Examples"
Index root is libraries/MySensors with recursive search
No LaTeX generation
Documentation/html added to .gitignore
2015-12-11 00:40:02 +01:00