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: doxygen review on remaining common headers #2627

Conversation

@b-gent
Copy link
Contributor

@b-gent b-gent commented Nov 17, 2020

The PR covers the remaining high-priority headers from the common folder.

  • textconsole.h
  • timer.h
  • translation.h
  • ustr.h
  • util.h

HTML output available here:
https://b-gent.github.io/2627/d7/da5/group__common__text__console.html

@b-gent
Copy link
Contributor Author

@b-gent b-gent commented Nov 17, 2020

I'll fix the conflict tomorrow.

@b-gent b-gent force-pushed the b-gent:improve_doxygen_in_high_priority_headers_3 branch from 02ecc42 to 2774808 Nov 17, 2020
@b-gent
Copy link
Contributor Author

@b-gent b-gent commented Nov 17, 2020

This is ready for review @sev- @criezy

Copy link
Member

@criezy criezy left a comment

First pass on textconsole.h, timer.h, and translation.h.
I will look at the other two files later this week.

common/textconsole.h Outdated Show resolved Hide resolved
common/translation.h Outdated Show resolved Hide resolved
common/translation.h Outdated Show resolved Hide resolved
common/translation.h Outdated Show resolved Hide resolved
common/translation.h Outdated Show resolved Hide resolved
common/translation.h Show resolved Hide resolved
common/translation.h Outdated Show resolved Hide resolved
common/ustr.h Outdated Show resolved Hide resolved
common/util.h Outdated Show resolved Hide resolved
common/ustr.h Outdated Show resolved Hide resolved
common/ustr.h Outdated Show resolved Hide resolved
common/ustr.h Outdated Show resolved Hide resolved
common/ustr.h Outdated Show resolved Hide resolved
common/ustr.h Outdated Show resolved Hide resolved
- textconsole.h
- timer.h
- translation.h
- ustr.h
- util.h
@b-gent b-gent force-pushed the b-gent:improve_doxygen_in_high_priority_headers_3 branch from 2774808 to a815678 Nov 22, 2020
@b-gent
Copy link
Contributor Author

@b-gent b-gent commented Nov 22, 2020

Comments fixed, thank you for reviews @criezy and @mgerhardy
This should be good to go now.

@b-gent b-gent requested a review from criezy Nov 22, 2020
@criezy
criezy approved these changes Nov 22, 2020
Copy link
Member

@criezy criezy left a comment

Thank you. This looks good now.
There is one minor issue that I will fix when merging.

@criezy
Copy link
Member

@criezy criezy commented Nov 22, 2020

And merged.

@criezy criezy closed this Nov 22, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants
You can’t perform that action at this time.