Commit Graph

25 Commits

Author SHA1 Message Date
David Madison
8e143e204c Update Doxyfile version to 1.9.7
Using "doxygen -u" command on local machine
2023-05-29 16:12:14 -04:00
David Madison
15712b857d Restore old FastLED logo in Doxygen
Thank you @marmilicious for pointing this out!
2022-03-27 04:12:24 -04:00
David Madison
602bd81c01 Add all examples to Doxygen 2022-03-25 03:53:47 -04:00
David Madison
86aaf9c9a3 Use detailed description as default in Doxygen
There are a number of detailed descriptions for classes and groups that are otherwise buried far down the page. This changes the layout of the generated documentation so the detailed description is at the very top, in place of the brief description.
2022-03-25 01:43:37 -04:00
David Madison
b6a04611c2 Create DoxygenLayout.xml 2022-03-25 01:43:37 -04:00
David Madison
51cc844f02 Delete mainpage.dox
This is no longer needed since Doxygen can now use the repository README
2022-03-25 01:43:37 -04:00
David Madison
9f830fbb25 Update colorutils.cpp documentation 2022-03-24 01:26:06 -04:00
David Madison
d41b901117 Add 3rd party library defines to Doxyfile
For generating the associated addLeds() function defines. Should have been included in 24cd701.
2022-03-23 00:54:31 -04:00
David Madison
e21ee19e70 Prefix DOXYGEN macro with FASTLED
Guarding against other libraries that may inadvertently leak a DOXYGEN define and cause unintended behavior.
2022-03-20 01:16:50 -04:00
David Madison
8e4f1ef64a Exclude src/platforms from Doxygen
Ignoring these for the time-being, as the Doxygen documentation is not focused on the platform-specific implementations.
2022-03-19 21:37:20 -04:00
David Madison
822c0c5add Update colorpalettes documentation 2022-03-19 20:24:50 -04:00
David Madison
dc9eb444b4 Update pixeltypes.h documentation
This also adds a doxyfile "alias" to generate HTML color blocks for each HTML color enumeration.
2022-03-19 02:40:13 -04:00
David Madison
15ecc8dc02 Update fastled_config.h documentation
This adds a DOXYGEN exclusive preprocessor block (and associated define in the Doxyfile) so the parser can find the config symbols that are commented out by default.
2022-03-19 00:45:27 -04:00
David Madison
027e6917a3 Hide __attribute__((always_inline)) in docs
The GCC attribute was confusing Doxygen's function signatures and is for optimization purposes - it isn't necessary for understanding what each function does.
2022-03-18 21:34:08 -04:00
David Madison
787802383b Update FastLED.h documentation 2022-03-18 04:32:04 -04:00
David Madison
2176990019 Add Doxygen Awesome theme and logo 2022-03-18 01:50:40 -04:00
David Madison
f6bd614177 Fix Doxyfile input directory 2022-03-18 01:36:32 -04:00
David Madison
d74edd0c15 Update Doxyfile to 1.9.3 2022-03-18 01:28:14 -04:00
Martin Falatic
e3eb2e25e2 Update to work with Doxygen 1.8.18; update .gitignore 2020-05-30 01:14:00 -07:00
Daniel Garcia
45b804fe04 Merge branch 'master' into rgbw 2016-01-23 14:15:34 -05:00
Daniel Garcia
e323848665 doxy tweaks 2015-11-21 16:17:14 -08:00
Daniel Garcia
fd3b375d9d removing files that shouldn't be doc'd 2015-08-10 22:40:29 -07:00
Daniel Garcia
0e26499914 Start splitting out lib8tion code into separate files, convert documentation format to doxygen as well. 2015-08-10 22:01:41 -07:00
Daniel Garcia
8b398eebf6 Adding more docs 2014-12-01 21:23:45 -08:00
Daniel Garcia
9719d9de8a Adding beginnings of doxygen documentation. 2014-11-30 21:19:35 -08:00