Update Doxygen doxyfile #903
Merged
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
Since 93e7287, it has been excluded by EXCLUDE_PATTERNS.
This makes it easier to see where a file is included. STRIP_FROM_PATH = ../../ makes all paths referenced to the root of the Git repository (assuming doxygen is run in mythtv/docs/)
This makes the recommended include line more useful on class documentation pages. Instead of listing just the filename, it gives a usable path for the libraries and tells you which library, program, or plugin the class is in.
All moc_*.(h|cpp) files are in a moc folder. All obj folders are generated during build. The i18n folders in mythplugins only contain generated files. I considered adding: */external/* but I'm leaving it for mythtranscode/external/replex */scripts/* I don't think any of these are useful to doxygen, but I'm not sure.
402: warning: end of comment block while expecting command </em> 401: warning: found </em> tag without matching <em> Also removed extraneous character preventing line break from working correctly.
|
After building with cmake, use the following command: I tried to document everything in README.CMake.md. If you can't find something there, let me know. |
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.
This should help to make the docs more useful.
@linuxdude42 I'm not sure how to test the cmake changes, but I followed what you did.
Checklist