search

openqasm / qe-compiler

An MLIR based compiler dynamic circuit compiler for real-time control systems supporting OpenQASM 3
Other
38 stars 12 forks source link

Doxygen comments and documentation - Add CI to generate it #72

Open jgsogo opened 1 year ago

jgsogo commented 1 year ago

From https://github.com/Qiskit/qss-compiler/pull/63 review, some of the /// comments were a bit of unexpected for reviewers. They are doxygen-style comments for documentation.

We need to decide if we want to document the source or not so we can enforce it in either direction in our reviews.

cc/ @vrpascuzzi

taalexander commented 1 year ago

Hi @jgsogo, can you please link me to these comments? In general, we will support doxygen style comments (and have not yet migrated our documentation which we still build internally).

jgsogo commented 1 year ago

You can find some comments starting with /// in the codebase, like https://github.com/Qiskit/qss-compiler/blob/main/include/HAL/TargetRegistry.h#L48

taalexander commented 1 year ago

To clarify, we do wish to support Doxygen comments and the generation of Doxygen documentation.