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

Documentation fragments and comments in OpenQL source could be improved #479

Open
jvansomeren opened this issue May 4, 2023 · 0 comments

Comments

@jvansomeren
Copy link
Collaborator

In general, we'd like header files of classes to contain only comment that is functional (implementation independent),
and implementation files of classes explain the various implementation options/choices.
Note that header file comment is also used by doxygen.
Documentation fragments are used to compose the readthedocs documentation and should thus be functional;
this can be improved, partially by simplifying the interfaces of course (not this issue), and otherwise by being more clear on the various cases, models, constraints, etc. An example is the meaning of options; perhaps some should be taken out of the readthedocs fragments because they are too much implementation related.

For this issue, first the documentation fragments, then the header file comment and then the implementation file comments are revised.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant