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>
46 lines
1.0 KiB
Markdown
46 lines
1.0 KiB
Markdown
# Connection
|
|
|
|
`class Connection` — inherits [SystemElement](../classes/SystemElement.md)
|
|
|
|
Defined in [connect.hpp:13](../../../../src/system/connect.hpp#L13)
|
|
|
|
## Public Attributes
|
|
|
|
### `Module * m1`
|
|
|
|
📍 [connect.hpp:16](../../../../src/system/connect.hpp#L16)
|
|
|
|
### `Part * p1`
|
|
|
|
📍 [connect.hpp:17](../../../../src/system/connect.hpp#L17)
|
|
|
|
### `Module * m2`
|
|
|
|
📍 [connect.hpp:18](../../../../src/system/connect.hpp#L18)
|
|
|
|
### `Part * p2`
|
|
|
|
📍 [connect.hpp:19](../../../../src/system/connect.hpp#L19)
|
|
|
|
### `std::string transform_name`
|
|
|
|
📍 [connect.hpp:20](../../../../src/system/connect.hpp#L20)
|
|
|
|
### `std::vector< std::pair< Pin *, Pin * > > pin_map`
|
|
|
|
📍 [connect.hpp:21](../../../../src/system/connect.hpp#L21)
|
|
|
|
## Public Functions
|
|
|
|
### `Connection(std::string name)`
|
|
|
|
📍 [connect.hpp:23](../../../../src/system/connect.hpp#L23)
|
|
|
|
### `Connection(std::string name, Module *m1, Part *p1, Module *m2, Part *p2)`
|
|
|
|
📍 [connect.hpp:24](../../../../src/system/connect.hpp#L24)
|
|
|
|
---
|
|
|
|
← [Back to classes](index.md) · [Top](../index.md)
|