Skip to content

Docs: Mail docs fixed #8530

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
Merged
merged 3 commits into from
Oct 27, 2018
Merged

Docs: Mail docs fixed #8530

merged 3 commits into from
Oct 27, 2018

Conversation

paul-szczepanek-arm
Copy link
Member

Description

Fixed doxygen comments, hidden private.

Pull request type

[ ] Fix
[ ] Refactor
[ ] Target update
[ ] Functionality change
[x] Docs update
[ ] Test update
[ ] Breaking change

@AnotherButler
Copy link
Contributor

Anything that's not public should not be rendered in the Doxygen.

@paul-szczepanek-arm
Copy link
Member Author

Apparently by default doxygen ignores private members already. Unless you explicitly configured it to pick up private in which case it will be faster to disable that option than to manually enclose private members.

@AnotherButler
Copy link
Contributor

@paul-szczepanek-arm Thanks for explaining that 👍 That's pretty cool. Has it always been like that, or is it new?

@paul-szczepanek-arm
Copy link
Member Author

I don't know. I guess whoever has the access to the doxygen cfg file needs to check this:
https://www.stack.nl/~dimitri/doxygen/manual/config.html#cfg_extract_private

cmonr
cmonr approved these changes Oct 25, 2018
View reviewed changes
Copy link
Contributor

@cmonr cmonr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

paul-szczepanek-arm and others added 3 commits October 25, 2018 21:47
@paul-szczepanek-arm
fix docs in Mail
1b38b5a
@paul-szczepanek-arm
no doxygen guards needed for private
f57d897
Edit Mail.h
5abe427 
Edit file for active voice, branding and comma use.
@cmonr
Copy link
Contributor

cmonr commented Oct 26, 2018

Rebased to fix conflicts.

@cmonr cmonr mentioned this pull request Oct 26, 2018
Merged
@cmonr
Copy link
Contributor

cmonr commented Oct 26, 2018

Note: This PR is now a part of a rollup PR (#8552).

No further work is needed here, as once that PR is merged, this PR will also be closed and marked as merged.

@cmonr cmonr merged commit 5abe427 into ARMmbed:master Oct 27, 2018
@adbridge
Copy link
Contributor

adbridge commented Nov 2, 2018

This is sitting on top of #8365 which is going to 5.11

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cmonr cmonr cmonr approved these changes

@AnotherButler AnotherButler AnotherButler approved these changes

Assignees
No one assigned
Labels
release-version: 5.11.0-rc1
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@paul-szczepanek-arm @AnotherButler @cmonr @adbridge