Docgen

Generated by moondeck/check/check_docgen.py on every run. Do not edit by hand.

Every place the generated documentation breaks the shape the standards define. Current state only: the trend is this file's git history. The list only shrinks.

0 error(s) and 2919 warning(s) across 207 page(s).

An error is in a file that generates a documentation page, a header or a catalog page, so the finding is a defect in what gets published and it fails the gate. A warning is in an implementation file, which publishes nothing: its comments are a note to the next reader, worth fixing without being worth stopping a commit for. Both are counted here, because a warning nobody sees is a warning nobody fixes.

The split is temporary. It stages the sweep rather than ranking the two kinds of comment, so when the warning column reaches zero it goes and every finding blocks.

By rule

Rule	Errors	Warnings
over-wide comment lines	0	2089
multi-line comment blocks	0	542
over-long sentences	0	103
over-wide doc lines	0	96
member deep dives	0	89

By documentation area

The unit a sweep runs in: one summary page and the headers it owns, as the hierarchy zoom lays them out. A page is swept when its errors reach zero; its warnings say how much implementation-file cleanup is left behind that.

Summary page	Errors	Warnings
(tests, no card)	0	2112
platform/index.md	0	477
core/system.md	0	330

Where the work is

Per area, since that is the unit a sweep runs in: the files ranked, then the rule mix. A file's own findings are in the check's output, which names every one.

(tests, no card)

0 error(s) and 2112 warning(s) across 178 file(s).

Findings	File
147	test/unit/core/unit_moonlive_compiler.cpp	warning
94	test/unit/light/unit_MoonLiveLayout.cpp	warning
74	test/unit/light/unit_ParallelLedDriver_ring.cpp	warning
65	test/unit/light/unit_ParallelLedDriver_pinexpander.cpp	warning
60	test/unit/core/unit_moonlive_fill.cpp	warning
51	test/unit/core/unit_moonlive_codegen_x86_64.cpp	warning
48	test/unit/light/unit_Effects_gridsweep.cpp	warning
44	test/unit/core/unit_moonlive_codegen_xtensa.cpp	warning
42	test/unit/light/unit_ParallelSlots.cpp	warning
41	test/unit/core/unit_ControlModule.cpp	warning
1-38 each	168 more warning files, 1446 findings

By rule, warnings: 1601 over-wide comment lines, 229 multi-line comment blocks, 101 over-long sentences, 95 over-wide doc lines, 86 member deep dives.

platform/index.md

0 error(s) and 477 warning(s) across 23 file(s).

Findings	File
90	src/platform/esp32/platform_esp32_moon_i80.cpp	warning
80	src/platform/esp32/platform_esp32.cpp	warning
51	src/platform/desktop/platform_desktop.cpp	warning
35	src/platform/esp32/platform_esp32_i80.cpp	warning
34	src/platform/esp32/moonlive_asm_xtensa.cpp	warning
30	src/platform/desktop/moonlive_asm_x86_64.cpp	warning
30	src/platform/esp32/platform_esp32_rmt.cpp	warning
23	src/platform/esp32/moonlive_asm_riscv.cpp	warning
21	src/platform/desktop/moonlive_asm_arm64.cpp	warning
19	src/platform/esp32/platform_esp32_parlio.cpp	warning
1-10 each	13 more warning files, 64 findings

By rule, warnings: 330 over-wide comment lines, 147 multi-line comment blocks.

core/system.md

0 error(s) and 330 warning(s) across 6 file(s).

Findings	File
197	src/core/system/HttpServerModule.cpp	warning
40	src/core/system/FilesystemModule.cpp	warning
39	moonbase/main/moonbase_main.cpp	warning
26	src/core/module/Control.cpp	warning
19	src/core/module/Scheduler.cpp	warning
9	src/core/system/FileManagerModule.cpp	warning

By rule, warnings: 166 multi-line comment blocks, 158 over-wide comment lines, 3 member deep dives, 2 over-long sentences, 1 over-wide doc lines.