Auto-generated API doc: doxygen → custom Python emitter → doc/api/.
`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>
This commit is contained in:
33
doc/api/classes/ImportOds.md
Normal file
33
doc/api/classes/ImportOds.md
Normal file
@@ -0,0 +1,33 @@
|
||||
# ImportOds
|
||||
|
||||
`class ImportOds` — inherits [ImportBase](../classes/ImportBase.md)
|
||||
|
||||
Defined in [import_ods.hpp:6](../../../../src/imports/import_ods.hpp#L6)
|
||||
|
||||
## Private Attributes
|
||||
|
||||
### `std::string filename_`
|
||||
|
||||
📍 [import_ods.hpp:8](../../../../src/imports/import_ods.hpp#L8)
|
||||
|
||||
## Public Functions
|
||||
|
||||
### `ImportOds(std::string filename)`
|
||||
|
||||
📍 [import_ods.hpp:11](../../../../src/imports/import_ods.hpp#L11)
|
||||
|
||||
### `void parse(Signals *signals) override`
|
||||
|
||||
📍 [import_ods.hpp:12](../../../../src/imports/import_ods.hpp#L12)
|
||||
|
||||
Pure virtual method for parsing the file.
|
||||
|
||||
Derived classes must implement this method to define how the file is parsed.
|
||||
|
||||
**Parameters**
|
||||
|
||||
- `signals` — Pointer to the signals object to be completed.
|
||||
|
||||
---
|
||||
|
||||
← [Back to classes](index.md) · [Top](../index.md)
|
||||
Reference in New Issue
Block a user