Commit Graph

1802 Commits

Author SHA1 Message Date
David Madison
12f18a832c Move dithering macros outside of function for doc
This moves the dither macros outside of the PixelController::init_binary_dithering() function so that Doxygen doesn't get confused. This requires duplicating the preprocessor conditional, but since macros aren't scoped to the function regardless I don't see it as an issue.

These probably should be replaced with constants scoped to the function, but that's not a change I want to make right now. Adding a \todo note.

There are no intended functional changes in this commit.
2022-03-20 03:58:52 -04:00
David Madison
24cd7012a8 Update missing addLeds() documentation blocks
This also includes the addLeds() functions for the third party libraries supported by CFastLED: SmartMatrix, OctoWS2811, and WS2812Serial.

Unfortunately Doxygen has not quite figured out how to handle \copydoc with overloaded functions that have template parameters, so the per-addLeds() comments are limited to the brief. The section header with the parameter names will have to suffice.
2022-03-20 03:22:52 -04:00
David Madison
c2fbf05a61 Fix Doxygen noise average 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 noise.cpp, 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.
2022-03-20 02:39:46 -04:00
David Madison
e35ed75076 Remove INCLUDE_PGMSPACE doc callout
This isn't important to document since it's used immediately after creation and nowhere else. And since Doxygen isn't processing it properly, there's no reason to keep the comment block around.
2022-03-20 02:36:30 -04:00
David Madison
ee7955bde0 Remove Doxygen groups from power_mgt.h
There aren't enough of these to warrant their own modules - named sections is fine.
2022-03-20 02:30:19 -04:00
David Madison
d203e66964 Remove bitswap Doxygen group
These functions are only used at the lower level for parallel output hardware. They can certainly stay documented, but there's no reason to highlight them in the general user documentation.
2022-03-20 02:21:09 -04:00
David Madison
9a320754fb Update fastled_progmem.h documentation
Note that this creates another preprocessor block for Doxygen. Doxygen doesn't seem to know how to document a preprocessor macro if it's defined in the Doxyfile and not in the code itself.
2022-03-20 02:19:24 -04:00
David Madison
c66afbb9d1 Update bitswap documentation 2022-03-20 01:50:42 -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
614b2d843b Update led_sysdefs documentation (NS)
Overlooked the documentation for these namespace directives the first time around (499f96f)
2022-03-20 01:04:07 -04:00
David Madison
435904ae39 Update noise.h documentation 2022-03-20 01:01:49 -04:00
David Madison
b2b996741a Update power_mgt.h documentation 2022-03-19 22:14:42 -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
2d80613674 Move palette and gamma docs out of util group
Keeping the "ColorUtils" group to things like filling, blending, and fading.
2022-03-19 21:32:16 -04:00
David Madison
d6fc019ea7 Update hsv2rgb documentation 2022-03-19 21:29:13 -04:00
David Madison
822c0c5add Update colorpalettes documentation 2022-03-19 20:24:50 -04:00
David Madison
7c4386a761 Update colorutils.h documentation
This was a big one, but all of the color utilities are now thoroughly documented and organized.

There are a few repeated messages in the color palettes classes, as Doxygen was having issues locating symbols for the constructors with array arguments (e.g. `const CRGB rhs[16]`) and the `operator CRGB*` arguments (possibly due to the spaces?). But those are small enough it's not worth worrying about.
2022-03-19 19:22:05 -04:00
David Madison
26fb78113d Standardize fill func argument names
No functional change. This makes the documentation copying easier.
2022-03-19 03:01:02 -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
631c1a0b7b Update platforms.h documentation 2022-03-18 22:58:33 -04:00
David Madison
499f96fb3b Update led_sysdefs.h documentation 2022-03-18 22:57:06 -04:00
David Madison
1bf0bf06c2 Update color.h documentation 2022-03-18 22:46:39 -04:00
David Madison
57e31e0c45 Update controller.h documentation 2022-03-18 22:13:36 -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
cb9192b5c5 Fix release tag parsing for Doxygen action 2022-03-18 02:23:51 -04:00
David Madison
927f6da6f2 Create GitHub Pages Doxygen workflow 2022-03-18 02:06:18 -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
Seth Troisi
4fbd3f42ea Reduce number of warnings during CI 2022-02-26 18:50:32 -08:00
Seth Troisi
adade9d248 Prevent -Wunused-but-set-variable in clockless_rmt_esp32.h 2022-02-22 15:18:04 -08:00
Tochinet
611fa55f10
Update SmartMatrix.ino 2022-01-31 17:38:14 +01:00
Tochinet
e1ca95266f
Update SmartMatrix.ino 2022-01-31 17:35:15 +01:00
Sol Huebner
489baaba55
Add FastLED as ESP-IDF component support
Enables FastLED as ESP-IDF component support (with Arduino as component)
2022-01-15 19:22:21 -05:00
Sab78
d1e3b43a9d
Update chipsets.h
Fixed a bug in the LPD6803Controller class. Multiple diodes at the end of the LEDS array did not work correctly, no data was sent from the array to the LPD6803.
2022-01-12 14:39:14 +03:00
Marc Miller
2e87849df8 Update release_notes.md
Spelling fix - Particle Photon (instead of Partical)
2022-01-03 11:38:06 -08:00
Ben XO
b87a03d5bf
update README to 3.5 2022-01-03 03:02:46 +00:00
David Madison
bbce974dc7 Add fill_circular keywords 2022-01-02 17:07:06 -05:00
David Madison
dd30fd9143 Add reversing option to fill_circular functions 2022-01-02 16:25:43 -05:00
David Madison
f2da89411b Reduce circular precision constants by 1
256 * 256 - 1, to fit into a uint16_t (2^16)
2022-01-02 16:07:11 -05:00
David Madison
3ebf7bf483 Add brightness and blend defaults to fill_palette 2022-01-02 15:56:53 -05:00
David Madison
5cc52a289a Create fill_palette_circular function 2022-01-02 15:40:18 -05:00
David Madison
fd06f2c97f Refactor fill "endless" as fill "circular" 2022-01-02 15:19:01 -05:00
Mark Kriegsman
4d73cddfe4 FastLED Release 3.5.0, with expanded board support, and many other improvements and bug fixes. 2022-01-02 14:44:08 -05:00
Mark Kriegsman
016a7215f6
Merge pull request #1314 from ssilverman/fix-teensy4-name
Fix name Teesy4HardwareSPIOutput->Teensy4HardwareSPIOutput
2022-01-02 12:39:32 -05:00
Mark Kriegsman
4582088b67
Merge pull request #1272 from ben-xo/feature/make-minimum-wait-optional
Make the minimum wait optional by defining NO_MINIMUM_WAIT
2022-01-02 12:38:14 -05:00
Mark Kriegsman
a67bedb3e5
Merge pull request #1266 from ben-xo/bugfix/avr-clockless-timer-remnant
Remove clobbering of TCCR0A left over from ancient times
2022-01-02 12:11:42 -05:00
Mark Kriegsman
8347679388
Merge pull request #1267 from ben-xo/bugfix/avr-clockless-trinket-hang-when-pixel-len-0
Prevent FastLED from hanging on 0-length pixel arrays
2022-01-02 12:10:20 -05:00