| Commit message (Collapse) | Author | Age | Files | Lines |
|---|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Due to a recent change in the new distribution of LaTeX in the handling of the "input" commands we get the error like:
```
Appendix D.
(../html/examples/group/latex/refman_doc.tex (../html/examples/group/latex//gro
up__group1.tex) [243]
! I can't write on file `../html/examples/group/latex//group__group2.aux'.
\@include ...mmediate \openout \@partaux "#1.aux"
\immediate \write \@partau...
l.3 \include{group__group2}
Please type another output file name
! Emergency stop.
\@include ...mmediate \openout \@partaux "#1.aux"
\immediate \write \@partau...
l.3 \include{group__group2}
*** (job aborted, file error in nonstop mode)
```
The problem is that now an intermediate file is written to `../html/examples/group/latex//group__group2.aux` that was written in the older distributions as `./group__group2.aux`, so in the current directory.
Writing to sub directories of the current directory is possible but it is not allowed (unless special, dangerous, options are used) to write to directories outside tgese directories.
(see also: https://tex.stackexchange.com/questions/575120/problem-writing-aux-file)
This fix writes the examples in subdirectories in the latex directory and not under the, parallel, html directory. This means also that there is a cleaner and clearer distinction between the html and latex output.
|
| |
|
|
|
| |
This is a follow-up on pull request #8199 (Have build of doxygen documentation fail on warnings.) and #8197 (issue #8023 Add option to exit with non-zero exit code on warnings even if WARN_AS_ERROR is OFF).
These were 2 independent situation, but as with #8197 incor[porated into doxygen it is no possible to extend #8199 to fail but at present all warnings of the first (sub-)task that fails.
|
| |
|
|
|
| |
Currently when running doxygen to create its documentation no error is given when a warning is generated, so the warning might go unnoticed.
By setting `WARN_AS_ERROR = YES` the generation will stop and when build on CI systems a build also fails
|
|
|
Javadoc allows comments like this (which I refer to as "banner" comments)
/*****************
*
*****************/
but doxygen does not recognize them.
Instead, the doxygen manual says to do this
/*************//**
*
****************/
which some users aren't even aware is required. It also behaves poorly with clang-format.
I'm proposing to add a Doxyfile boolean option JAVADOC_BANNER which will default to NO. When set to YES, it will consider the first and second comments above to be equivalent.
However, I don't believe that the JAVADOC_BANNER option should default to YES, as there are likely a number of projects who have used the former syntax with full expectation that it would *not* appear in their documentation.
At least having the JAVADOC_BANNER default to NO allows users to opt-in voluntarily by adding JAVADOC_BANNER = YES to their Doxyfile. If the consensus is to make it a default at a later time, first a warning can be added during build that should trigger users to modify their comment style, and then eventually the default could be set to JAVADOC_BANNER = YES, or the config option could be removed entirely and it would just always be enabled.
|
