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

GUI: Doxygen code doc generation and coverage #243

Closed
rakhimov opened this issue Dec 23, 2017 · 0 comments
Closed

GUI: Doxygen code doc generation and coverage #243

rakhimov opened this issue Dec 23, 2017 · 0 comments
Labels
doc gui quality
Milestone
v0.16.1

Comments

@rakhimov
Copy link
Owner

No description provided.

@rakhimov rakhimov added this to the v0.16.1 milestone Dec 23, 2017
rakhimov added a commit that referenced this issue Dec 30, 2017
@rakhimov
GUI: Add Doxygen config file for Travis CI lint
c2a295d 
There are many documentation warnings,
so linting is not yet made strict on CI.

Issue #243
rakhimov added a commit that referenced this issue Jan 1, 2018
@rakhimov
GUI: Add all the missing documentation
ca26369 
Issue #243
rakhimov added a commit that referenced this issue Jan 1, 2018
@rakhimov
GUI: Make documentation coverage strict on Travis
ff34800 
Issue #243
rakhimov added a commit that referenced this issue Jan 1, 2018
@rakhimov
GUI: Add a link to TODO list of the GUI code
b2bb8be 
[skip ci]

This is generated by Doxygen from the code comments.

Issue #243
rakhimov added a commit that referenced this issue Jan 1, 2018
@rakhimov
GUI: Add Doxygen '@file' to all source files
dced133 
This triggers documentation of the file and its global contents.

Issue #243
rakhimov added a commit that referenced this issue Jan 1, 2018
@rakhimov
Remove explicit file names in Doxygen @file docs
6e856da 
Doxygen is smart enough to use the comments for the current file.
It is maintenance burden to put filenames.

Issue #243
rakhimov added a commit that referenced this issue Jan 1, 2018
@rakhimov
Check for missing '@file' doc in Travis CI lint
606cd04 
Doxygen does not warn about missing file doc.

Issue #243
rakhimov added a commit that referenced this issue Jan 1, 2018
@rakhimov
Put the reference link to the GUI code docs
25a1011 
Issue #243
@rakhimov rakhimov closed this as completed Jan 1, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
doc gui quality
Projects
None yet
Milestone
v0.16.1
Development

No branches or pull requests
1 participant
@rakhimov