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: Further doc updates in high priority files #2535

Open
wants to merge 1 commit into
base: master
from

Conversation

@b-gent
Copy link
Contributor

@b-gent b-gent commented Oct 16, 2020

Adding, editing, updating doxygen comments in header files.

HTML output available at: https://b-gent.github.io/PR2535/d6/d8f/class_common_1_1_config_manager.html

@b-gent b-gent force-pushed the b-gent:improve_doxygen_in_high_priority_headers branch 6 times, most recently from ef79e27 to b244784 Oct 17, 2020
@b-gent
Copy link
Contributor Author

@b-gent b-gent commented Oct 21, 2020

The last commit added the rest of missing doxygen in str.h. I won't add any more files to this PR and will open a new one instead, it's already a lot to review.
HTML output is updated here: https://b-gent.github.io/PR2535/d8/dbd/group__common__str.html

Please use the suggestion option to correct me in the given lines, I'm sure there will be quite a few. My approach was to add as much as possible, even where I really wasn't sure.

I will rebase tomorrow, the merge conflict in config-manager looks pretty bad.
@sev-

T &operator[](size_type idx) {
assert(idx < _size);
return _storage[idx];
}

/** Return a pointer to the underlying memory serving as element storage. */

This comment has been minimized.

@mgerhardy

mgerhardy Oct 24, 2020
Contributor

These an a few of the following look like whitespace errors

This comment has been minimized.

@b-gent

b-gent Oct 24, 2020
Author Contributor

thanks, I'll make sure to align with function declaration

This comment has been minimized.

@b-gent

b-gent Oct 25, 2020
Author Contributor

They all seem well-aligned actually, you can check it for yourself in the raw source view of the file -> https://github.com/scummvm/scummvm/blob/3bd1b124f233d2a66cecf532de1f60e6f1d6140f/common/array.h

Unless you meant something else by 'whitespace error'? The whitespace between the full stop and doxygen comment closing is intentional and used consistently everywhere as part of doxygen style, for better readability.

@b-gent b-gent force-pushed the b-gent:improve_doxygen_in_high_priority_headers branch from b244784 to 5d8906a Oct 25, 2020
@b-gent
Copy link
Contributor Author

@b-gent b-gent commented Oct 25, 2020

Rebased. It wasn't as bad as it seemed - this commit introduced some serious changes in line spacing so git showed a lot of changed lines but content was not the issue. So the only addition coming from master was this.

Adding, editing, updating doxygen comments in header files.
@b-gent b-gent force-pushed the b-gent:improve_doxygen_in_high_priority_headers branch from 5d8906a to 3bd1b12 Oct 25, 2020
bool tryGetVal(const String &key, String &out) const { return _entries.tryGetVal(key, out); }
String &getVal(const String &key) { return _entries.getVal(key); } /*!< Retrieve the value of a @p key. */
const String &getVal(const String &key) const { return _entries.getVal(key); } /*!< @overload */
/**

This comment has been minimized.

@b-gent

b-gent Oct 25, 2020
Author Contributor

@henke37 you added this recently, can you let me know what the right description is?

This comment has been minimized.

@henke37

henke37 Oct 25, 2020
Contributor

It retrieves the value if the key exists and leaves the referenced variable unchanged if the key does not exist. The return value is true if the key existed and false if it did not.

This comment has been minimized.

@b-gent

b-gent Oct 26, 2020
Author Contributor

thanks

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.