Hopefully the final fix to yet another Doxygen failure #630
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
Yet another case of Doxygen unable to create a directory, however this time it fails silently. Sigh. This fails when generating public docs and the build/docs/ directory doesn't exist. The m.css scripts creates build/docs-public/ in that case, so tell Doxygen to put everything there, including the tagfile.
facebook-github-bot
added
the
CLA Signed
Codecov Report
@@ Coverage Diff @@
## master #630 +/- ##
==========================================
- Coverage 57.78% 57.76% -0.02%
==========================================
Files 135 135
Lines 5974 5974
Branches 84 84
==========================================
- Hits 3452 3451 -1
- Misses 2522 2523 +1
Continue to review full report at Codecov.
|
|
Thank you for this! I tested this branch. Works. Re: C++ docs warnings: Agreed. CC: @bigbike @jturner65 @aclegg3 @eundersander as the people working most closely on the C++ codebase. |
Ram81
pushed a commit
to Ram81/habitat-web-sim
that referenced
this pull request
Dec 10, 2020
…rch#630) * doc: don't alias public and local tagfile location. Yet another case of Doxygen unable to create a directory, however this time it fails silently. Sigh. This fails when generating public docs and the build/docs/ directory doesn't exist. The m.css scripts creates build/docs-public/ in that case, so tell Doxygen to put everything there, including the tagfile. * doc: update Doxyfile once more.
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.
Motivation and Context
Followup to #624 based on a comment by @dhruvbatra.
Yet another case of Doxygen unable to create a directory, however this time it fails silently. Sigh.
When generating public docs and the
build/docs/directory didn't exist, Doxygen fails to createbuild/docs/habitat-cpp.tag, without any error, without any warning, nothing. To aid Doxygen in another case, m.css script createsbuild/docs-public/in that case, so tell Doxygen to put everything there, including the tagfile.Also updated the Doxyfile to what 1.8.18 expects, getting rid of one warning in the output. (Tangential: the C++ docs are a total mess, not even my 5000 line terminal history scrollback was enough to fit all the warnings, and it seems to be getting progressively worse. Unless people actively try to minimize the warnings by building docs locally and checking the output, this will never improve.)
How Has This Been Tested
Doc generation using
./build-public.shpasses now even with thebuilddirectory not existing before.Types of changes