Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
1 task done
jgsogo opened this issue Mar 9, 2023 · 3 comments
Open
1 task done

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

jgsogo opened this issue Mar 9, 2023 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@jgsogo
Copy link
Contributor

jgsogo commented Mar 9, 2023

From #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.

  • "we do wish to support Doxygen comments" ✍️ (Here)

cc/ @vrpascuzzi

@jgsogo jgsogo added the documentation Improvements or additions to documentation label Mar 9, 2023
@taalexander
Copy link
Collaborator

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
Copy link
Contributor Author

jgsogo commented Mar 10, 2023

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
Copy link
Collaborator

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

@jgsogo jgsogo changed the title Doxygen comments and documentation (yay or nay) Doxygen comments and documentation - Add CI to generate it Mar 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants