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>
1.8 KiB
1.8 KiB
ImportBase
class ImportBase
Defined in import_base.hpp:16
Base class for importing data from a file.
This class provides a foundation for parsing files and managing system parts and signals. Derived classes must implement the parse method. method.
Protected Attributes
Parts * prts
Pointer to the Parts object. object.
std::fstream file_lines
File stream for reading the input file.
Public Functions
ImportBase(std::string file_name)
Constructor for ImportBase..
Initializes the file stream and creates new Parts and and Signals objects. objects.
Parameters
file_name— Name of the file to be imported.
void parse(Signals *signals)=0
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.
Parts * parts()
Retrieves the Parts object. object.
Returns Pointer to the Parts object.
~ImportBase()=default
Virtual destructor for ImportBase..
Ensures proper cleanup of derived classes.
← Back to classes · Top