Doxygen cleanup #2605
Merged
Doxygen cleanup #2605
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Already declared in nonbonded_tab.hpp, probably a copy-paste mistake.
When the same Doxygen block appears in both the declaration (.hpp) and definition (.cpp) of a function, only keep it in the .hpp file.
* Removed most of the remaining Doxygen warnings (11 left, of which 7 are known bugs) * Updated all problematic \param * Added new groups when necessary * Updated several broken links * Reduced Doxygen duplication with \copybrief and \overloaded * Used ES_OK & ES_ERROR instead of 0 & 1 when it made sense to do so
The Clang -Wdocumentation option flags Doxygen syntax errors. These compiler warnings propagate through include statements. Went from 2416 warnings down to 833 warnings (that is from 61 unique warnings down to 26).
The Clang -Wdocumentation option flags empty \param commands. These compiler warnings propagate through include statements. Cleaned up struct members \brief to facilitate the use of \copybrief in empty \param lines. Went from 833 warnings down to 400 warnings (that is from 26 unique warnings down to 10).
The Clang -Wdocumentation option flags empty \param commands. These compiler warnings propagate through include statements. Many problematic functions were removed in upstream. Went from 400 warnings down to 0 warnings (that is from 10 unique warnings down to 0). The number of Doxygen warnings increased from 11 to 30.
* Removed most of the remaining Doxygen warnings introduced during the merge with upstream (10 left, 7 are known bugs) * Removed duplicate Doxygen blocks * Formatting
- input argument: `T*` -> `T const *const` - output argument: `T*` -> `T *const` - update \param directions accordingly
Coverxygen ReportMerging @@ Coverage Diff @@
## Items python #2605 +/- coverage ##
=====================================================
Files 30.6% 30.6% +0.0% 193/631
Namespaces 2.9% 2.9% +0.0% 2/69
Typedefs 8.4% 9.2% +0.8% 12/131
Defines 23.7% 23.7% +0.0% 123/519
Unions 100.0% 100.0% +0.0% 1/1
+ Structs 53.2% 55.2% +1.9% 85/154
Classes 23.0% 23.0% +0.0% 44/191
-> Variables 39.7% 40.2% +0.4% 654/1628
-> Friends 12.5% 12.5% +0.0% 1/8
+ Enums 40.0% 45.0% +5.0% 9/20
+ -> Values 50.7% 59.4% +8.7% 82/138
Functions 42.7% 43.1% +0.4% 1661/3855
+ -> param 26.8% 28.1% +1.3% 1567/5584
-> tparam 4.3% 4.3% +0.0% 17/392
=====================================================
+ Total 32.6% 33.4% +0.8% 4451/13321 |
Codecov Report
@@ Coverage Diff @@
## python #2605 +/- ##
=======================================
+ Coverage 78% 78% +<1%
=======================================
Files 496 496
Lines 27353 27354 +1
=======================================
+ Hits 21509 21510 +1
Misses 5844 5844
Continue to review full report at Codecov.
|
fweik
approved these changes
Mar 17, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes:
member <NAME> belongs to two different groups. The second one found here will be ignored.: happens when a function is declared in a group in the .hpp file but defined in another group in the .cpp file. This is usually caused by the "Private functions" and "Exported functions" groups in .hpp files.documented symbol <NAME> was not declared or defined.: known bug, fixed in 1.8.16no uniquely matching class member found for <NAME>: known bug, still not fixed-Wdocumentationcompiler warnings:#includerecursively@param p1,p2 Detailsand@return @ref ES_OKfail, see also bug 17437)runtime_errormessages (AutoParameters.hpp)ES_OKandES_ERRORinstead of0and1when it made sense to do so (if macros were mixed with hard-coded values, or just to be consistent across related functions)T*: input is nowT const *const, output is nowT *const