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.

Sign up for GitHub

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

Jump to bottom

Update doxygen configuration to require documentation #82

Closed
louis-langholtz opened this issue Sep 6, 2017 · 2 comments
Closed

Update doxygen configuration to require documentation #82

louis-langholtz opened this issue Sep 6, 2017 · 2 comments
Assignees
@louis-langholtz
Labels
Docs Use when issue or pull request relates to the documentation of the project. Enhancement For suggestions or changes that enhance any part of the project and isn't a bug.

Comments

@louis-langholtz
Copy link
Owner

Expected/Desired Behavior or Experience:

All PlayRho library interface code is documented. No new interface (i.e. public) code can pass the CI pull request verification without being fully documented.

Actual Behavior:

Doxygen only checks that documentation is valid. Doesn't identify undocumented code.
@louis-langholtz louis-langholtz added Docs Use when issue or pull request relates to the documentation of the project. Enhancement For suggestions or changes that enhance any part of the project and isn't a bug. labels Sep 6, 2017
@louis-langholtz louis-langholtz added this to the 1.0 Release milestone Sep 6, 2017
@louis-langholtz louis-langholtz self-assigned this Sep 6, 2017
@louis-langholtz louis-langholtz modified the milestones: Beta Launch, 1.0 Release Sep 6, 2017
@louis-langholtz
Copy link
Owner Author

louis-langholtz commented Sep 6, 2017 •
edited
Loading

This seems to also be related to issue #81.

@louis-langholtz
Copy link
Owner Author

Note that this requires over 1100 code declarations to get documented to avoid the pull request mechanism erring out. I've been resolving these but at least at the moment the count is still over 1000:

Documentation$ doxygen Doxyfile 2>&1 > /dev/null | wc -l
    1092

louis-langholtz added a commit that referenced this issue Sep 8, 2017
@louis-langholtz
For issue #82.
b9c6d10 
Adds documentation comments for everything that doxygen now detects as not-documented.
@louis-langholtz louis-langholtz mentioned this issue Sep 8, 2017
Merged
louis-langholtz added a commit that referenced this issue Sep 8, 2017
@louis-langholtz
Merge pull request #86 from louis-langholtz/for-issue-82
24e0995 
For issue #82.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@louis-langholtz louis-langholtz

Labels
Docs Use when issue or pull request relates to the documentation of the project. Enhancement For suggestions or changes that enhance any part of the project and isn't a bug.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@louis-langholtz