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>
44 lines
1.2 KiB
Markdown
44 lines
1.2 KiB
Markdown
# ImportMentor
|
|
|
|
`class ImportMentor` — inherits [ImportBase](../classes/ImportBase.md)
|
|
|
|
Defined in [import_mentor.hpp:8](../../../../src/imports/import_mentor.hpp#L8)
|
|
|
|
## Public Functions
|
|
|
|
### `ImportMentor(std::string filename)`
|
|
|
|
📍 [import_mentor.hpp:11](../../../../src/imports/import_mentor.hpp#L11)
|
|
|
|
Constructor for [ImportMentor](../classes/ImportMentor.md)..
|
|
|
|
Initializes the base class with the provided filename.
|
|
|
|
**Parameters**
|
|
|
|
- `filename` — Name of the file to be imported.
|
|
|
|
### `void parse(Signals *signals) override`
|
|
|
|
📍 [import_mentor.hpp:12](../../../../src/imports/import_mentor.hpp#L12)
|
|
|
|
Parses the file to extract parts, pins, and signals.
|
|
|
|
This method reads the file line by line, identifies parts and pins using regular expressions, and associates them with signals.
|
|
|
|
**Parameters**
|
|
|
|
- `signals` — Pointer to the [Signals](../classes/Signals.md) object used for managing signal connections.
|
|
|
|
### `~ImportMentor()`
|
|
|
|
📍 [import_mentor.hpp:13](../../../../src/imports/import_mentor.hpp#L13)
|
|
|
|
Destructor for [ImportMentor](../classes/ImportMentor.md)..
|
|
|
|
Ensures proper cleanup by calling the base class destructor.
|
|
|
|
---
|
|
|
|
← [Back to classes](index.md) · [Top](../index.md)
|