David Conran
f026c5c290
Fix broken doxygen action. ( #1577 )
...
* Fix doxygen action.
* Make the action run on every push.
* Tested that it detects a doxygen warning/error correctly.
2021-08-27 21:19:21 +10:00
David Conran
0683f123a0
Add an overview/intro for the Library API ( #1198 )
...
* Force docs/doxygen_index.md to be used as main page for the Doxygen documentation
* Initial version of doxygen_index.md
2020-06-17 23:37:20 +10:00
David Conran
546b7a2508
Enable Doxygen warning when the parameters for a function/method/procedure are wrong/missing. ( #1196 )
...
- Remove all `@return`s for class constructors. Apparently they are a no-no.
Note: Doesn't warn on something with absolutely no documentation. Just ones that have some.
2020-06-15 17:57:29 +10:00
David Conran
341cd7980b
Add Doxygen automatic documentation config for the library. ( #1150 )
...
* Initial Doxygen config.
* More general doxygen-ification of comments in various files.
* Several cleanups of existing doxygen comments.
For #1100
2020-05-29 12:09:55 +10:00
