lba.gitea/FastLED
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
1,802 Commits 12 Branches 32 Tags 17 MiB
master
Commit Graph

1802 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
Benoit Anastay
bbb974cf44 Update header 2022-03-28 01:20:36 +02:00
Benoit Anastay
580a51bef4 An attempt to update ESP8266 SPI integration 2022-03-28 01:07:23 +02: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
935cc153f8 Minor README tweaks 
Updated versions, capitalizing words where necessary, and slight language tweaks. No significant rewrites.
 2022-03-25 20:42:14 -04:00
David Madison
5e76fd6001 Add additional keywords 
This is not comprehensive, but it's better than it was.
 2022-03-25 04:24:41 -04:00
David Madison
602bd81c01 Add all examples to Doxygen 2022-03-25 03:53:47 -04:00
David Madison
41ce40e5e5 Change docs workflow to reference master branch 2022-03-25 02:16:43 -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
b85a136616 Change lib8tion doc sections to named groups 
This significantly cleans up the appearance of the "Fast Math" module page and makes it easier to read the group documentation in context.
 2022-03-25 01:43:37 -04:00
David Madison
9ffd32d743 Fix missing sfract15ToFloat range documentation 
Trusting that the sfract15 type range notes are correct.
 2022-03-25 01:43:37 -04:00
David Madison
801f107959 Improve \deprecated documentation fields 
Capitalize all entries, remove extra characters, reword for consistency, and provide extra lines where needed to fix whitespace parsing issues.
 2022-03-25 01:43:37 -04:00
David Madison
76d668c8c9 Improve \todo documentation fields 
Capitalize all entries, reword confusing tasks, and provide extra lines where needed to fix whitespace parsing issues.
 2022-03-25 01:00:29 -04:00
David Madison
b80db5b89d Update clockless controller docs in FastLED.h 
This change moves these to the ClocklessChipsets group like their parents, and with the same documentation.
 2022-03-25 00:45:50 -04:00
David Madison
3807487d6f Fix Doxygen clockless controller group info 
This should be clockless "chipsets" to match the clocked group and its parent group.

The group brief has also been updated to be similar to the clocked group brief.
 2022-03-25 00:43:27 -04:00
David Madison
ca97e98ef2 Update dmx.h documentation 2022-03-25 00:35:21 -04:00
David Madison
0f026633bf Update chipsets.h documentation 
Not entirely sure why Doxygen needs the \copydoc for showPixels(), but I think it's because the template parameters rely on the defaults for LANES and MASK in the derived controllers.
 2022-03-25 00:21:07 -04:00
David Madison
bb920bb00b Improve CLEDController function briefs 
Avoiding referencing another function in the brief, and instead rewording what each different function does.
 2022-03-24 23:32:02 -04:00
David Madison
0fba24b395 Fix Doxygen global brightness define in config 
If this doesn't exist then there's no issue, but because it *does* for the purposes of document symbol recognition it's causing problems.

Doxygen is complaining that it can't evaluate an expression properly in chipsets.h, as this is compared to an integer and it's defined as blank. To fix the issue this defines it as "0", so the integer comparison works, fails, and everyone is happy. Or at least happy enough to not publish warnings in the document generation log.

This is the same fix as included in c2fbf05, but with a different config option.
 2022-03-24 22:58:57 -04:00
David Madison
c43e6bd790 Update fastspi.h documentation 2022-03-24 22:52:27 -04:00
David Madison
2ceed838cf Update fastspi_bitbang.h 2022-03-24 22:42:19 -04:00
David Madison
bcbe4fe067 Update fastspi_types.h documentation 2022-03-24 21:14:07 -04:00
David Madison
14cac17435 Update fastled_delay.h documentation 2022-03-24 20:49:17 -04:00
David Madison
1c5465fa62 Update fastpin.h documentation 2022-03-24 03:55:01 -04:00
David Madison
d86d14539f Update fastspi_dma.h documentation 
Taking my best guess here, as the file is empty and appears to have no git history?
 2022-03-24 02:48:35 -04:00
David Madison
bd2f12e466 Update fastspi_nop.h documentation 2022-03-24 02:45:48 -04:00
David Madison
08f4061dfd Update fastspi_ref.h documentation 2022-03-24 02:45:33 -04:00
David Madison
b323ad1649 Update cpp_compat.h documentation 2022-03-24 02:30:49 -04:00
David Madison
6a423fad10 Update bitswap.cpp documentation 2022-03-24 02:26:16 -04:00
David Madison
c14a2687b7 Update lib8tion.cpp documentation 2022-03-24 02:25:09 -04:00
David Madison
29ef72c966 Update power_mgt.cpp documentation 2022-03-24 02:23:19 -04:00
David Madison
491c7459ef Update platforms.cpp documentation 2022-03-24 02:22:25 -04:00
David Madison
f6c6f6c858 Update noise.cpp documentation 
The changes included in noise.h are because fill_raw_2dnoise8() is overloaded in the source file, which caused Doxygen to get confused.
 2022-03-24 02:14:54 -04:00
David Madison
840d0e4707 Update hsv2rgb.cpp documentation 2022-03-24 01:51:26 -04:00
David Madison
306e75363e Add 'struct' to hsv2rgb function arg def 
As with 0551078, this fixes the discrepancy between the header and source files so that Doxygen can find the documentation.
 2022-03-24 01:36:13 -04:00
David Madison
b227ea7d07 Update wiring.cpp documentation 2022-03-24 01:29:29 -04:00
David Madison
9f830fbb25 Update colorutils.cpp documentation 2022-03-24 01:26:06 -04:00
David Madison
05510786cc Remove 'struct' from ColorFromPalette arg defs 
There was a discrepancy between the argument types for these ColorFromPalette functions in the header and the source. In the header they don't include the 'struct' keyword for the first parameter, and in the source they do. This was causing a function signature mismatch in Doxygen which highlighted the error.

This commit removes the 'struct' keyword so that the source functions match the signature in the header file.

I don't believe this is an actual change to the function signature as the linker has resolved it without issue to date? But I'm adding this change as its own commit because I'm not 100% sure.
 2022-03-24 01:18:54 -04:00
David Madison
4b6d3bb57e Update FastLED.cpp documentation 2022-03-24 01:08:28 -04:00
David Madison
3cfbc9e835 Update gamma group doc description 
For reference to what gamma values *are*, and for adding a reference to the Dimming group which performs similar math.
 2022-03-24 00:49:19 -04:00
David Madison
8c562a5f97 Update scale8.h documentation 2022-03-24 00:48:27 -04:00
David Madison
c8c054557a Update random8.h documentation 2022-03-23 23:32:47 -04:00
David Madison
6955763709 Update trig8.h documentation 2022-03-23 23:05:16 -04:00
David Madison
a9bcd808bb Update math8.h documentation 2022-03-23 22:26:57 -04:00
David Madison
c9636ec26b Update lib8tion.h documentation 
No intended functional changes, but this does create a few preprocessor macro checks using the FASTLED_DOXYGEN flag. One of those is the CEveryNTime class, separated from the macro to build it in context.
 2022-03-23 21:53:07 -04:00
David Madison
79e635005f Standardize fill_gradient doc briefs 
There's no reason to reference another function in the *brief*. This is cleaner and easier to understand at a glance.
 2022-03-23 03:12:09 -04:00
David Madison
a2cb0e235e Update pixelset.h documentation 2022-03-23 03:04:39 -04:00
David Madison
d80020e3fc Update missing controller.h documentation 
I had passed on documenting these in 57e31e0, but in the interest of thoroughness...
 2022-03-23 03:04:34 -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