Fix warnings and errors generated when running doxygen. #527
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
+ Correctly set doxygen parameters `PROJECT_LOGO` and `IMAGE_PATH`.
+ Update image inclusion instructions so they work.
+ Remove some cruft from mainpage (all those links are still available via the
"Related Pages" pull down.
+ Many, many fixes to comment blocks in source code to allow doxygen to
correctly parse the text.
- `\param` names should match C++ variables names.
- Remove duplicate full documenation blocks to avoid conflicts.
- Escape greater-than and less-than angle brackets so doxygen can parse
them.
- Document missing function variables.
- Remove documentation for function parameters that have been removed.
- Ensure declaration and definition of functions use `const` consistently.
+ Remove some dead code.
+ Fix indentation in a few places.
Codecov Report
@@ Coverage Diff @@
## develop #527 +/- ##
=========================================
- Coverage 93.3% 93.3% -0.1%
=========================================
Files 376 376
Lines 17653 17686 +33
=========================================
+ Hits 16484 16504 +20
- Misses 1169 1182 +13 |
KineticTheory
changed the title
KineticTheory
changed the title
|
@kgbudge This PR passes all tests (it is mostly just documentation changes). Can you review/approve/merge? Thx. |
…cros. Background Jayenne and Capsaicin should be able to use a lot of the same cmake macros for setting up a build system that creates html pages via doxygen. Attempt to package some of the build system code in a more reusable way. Changes: + Update formatting for `Copyright` and include this text directly into `mainpage.dcc`. + Create new file `autodoc_macros.cmake` that defines cmake macros and functions that will be used by `autodoc/CMakeLists.txt`. + Update `draco_info` so it can create a list of authors suitable for including in `mainpage.dcc.` + Add `autodoc/html/doxygen.css` to the list of files that will be installed in `cmake/draco` and that can be used by other projects. + The generated `Draco.tag` file is causing a warning `warning: Duplicate anchor HOST_NAME_MAX found` when used by other code projects. Attempt to silence this warning. + Increase the max number of dot graph nodes to 500 (was 200). + Update the `covdir.cfg` script so it is aware of Jayenne's new directory layout. + Rename structs A, B --> Apple, Banana in `cxx11example_move_semantics.cc` to prevent doxygen from linking the article 'A' to this struct.
KineticTheory
force-pushed
the
autodoc-fixes
branch
from
c01cc16
to
1eb04db
Compare
|
@kgbudge Do you have time to look at this and maybe merge it today (Friday)? I have Jayenne, Draco and Capsaicin branches that need to merged once this goes into If no, maybe @RyanWollaeger can look at it. It is a big change set, but the majority of the changes are in comment blocks. A few have to do with the build system for the |
|
Yeah, that's a large merge. I confess I skimmed a lot of it. Merging on the assumption that the coverage changers are an artefact that is acceptable. |
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.
Background
Purpose of Pull Request
Description of changes
PROJECT_LOGOandIMAGE_PATH.\paramnames should match C++ variables names.constconsistently.Status