Files
essim/doc/api/classes/ImportMentor.md
François 66460262af 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>
2026-05-12 08:13:15 +02:00

1.2 KiB

ImportMentor

class ImportMentor — inherits ImportBase

Defined in import_mentor.hpp:8

Public Functions

ImportMentor(std::string filename)

📍 import_mentor.hpp:11

Constructor for ImportMentor..

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

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 object used for managing signal connections.

~ImportMentor()

📍 import_mentor.hpp:13

Destructor for ImportMentor..

Ensures proper cleanup by calling the base class destructor.


Back to classes · Top