François
66460262af
`cmake --build build --target doc` runs Doxygen to produce XML, then `doc/gen_api_md.py` (~330 lines, stdlib-only) emits a Markdown tree under `doc/api/` that gitea renders directly in its file browser. - 24 class/struct pages + 51 source-file pages + indices, with source links of the form `../../../../src/...#L42` that gitea turns into clickable line-anchored links. - Doxyfile.in templated by CMake (XML-only output to build/doc/xml/). - Pure Python emitter, zero external deps — no doxybook2 (not packaged on Arch) and no moxygen (avoids Node). - Target gracefully disabled if Doxygen or Python 3 is missing at configure time; regular build target unaffected. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
32 lines
683 B
Markdown
32 lines
683 B
Markdown
# Signal
|
|
|
|
`class Signal` — inherits [SystemElementContainer< Pin >](../classes/SystemElementContainer.md)
|
|
|
|
Defined in [signals.hpp:11](../../../../src/system/signals.hpp#L11)
|
|
|
|
## Public Attributes
|
|
|
|
### `Signals * prnt`
|
|
|
|
📍 [signals.hpp:14](../../../../src/system/signals.hpp#L14)
|
|
|
|
Pointer to the parent signals object.
|
|
|
|
### `SignalType type`
|
|
|
|
📍 [signals.hpp:15](../../../../src/system/signals.hpp#L15)
|
|
|
|
## Public Functions
|
|
|
|
### `Signal(std::string name)`
|
|
|
|
📍 [signals.hpp:16](../../../../src/system/signals.hpp#L16)
|
|
|
|
### `void add(Pin *pin) override`
|
|
|
|
📍 [signals.hpp:17](../../../../src/system/signals.hpp#L17)
|
|
|
|
---
|
|
|
|
← [Back to classes](index.md) · [Top](../index.md)
|