| 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
|
| |
|
|
|
|
| |
very popular)
|
|
|
|
|
| |
Making more use of arrays in CMake to create the documentation of examples.
Renaming the template/templ example to have a more consistent naming with the other examples.
|
|
|
|
|
|
|
| |
Spelling corrections as found by codespell and in #561.
The dbusxml.xml file is not part of the doxygen distribution anymore.
Other problems are fixed here.
|
|
|
|
|
|
|
| |
documented.
Correcting code due to the fact that `//@{` isn't seen by doxygen as block start (#7116).
Thi s problem is shown when generating the doxygen documentation.
|
|\
| |
| |
| |
| | |
cfriedt/feature/cfriedt/6955/allow-javadoc-style-comment-blocks-with-a-doxyfile-variable
Allow Javadoc-style comment blocks with a Doxyfile variable
|
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| | |
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.
|
|/
|
|
| |
As, more or less, mentioned in the bug report: in version 1.7.6.1 the PERL_PATH is still in use (instdox.cpp) but in version 1.8.0 it is not used anymore, so the parameter has been set to obsolete now.
|
|
|
|
|
|
| |
- tag example corrected in respect to changed definition (a while ago) regarding the name of the Example example
- regenerating tag file (based on current doxygen version)
- made building of all examples uniform
|
|
|
|
|
| |
The current spelling (also for the older versions) is Javadoc.
Changed on all possible documentation visible places (external and internal).
|
| |
|
|\
| |
| | |
Generating doxygen documentation on Windows (with MikTex)
|
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| | |
The current version of MikTex gives the error message:
Appendix Z.
(../html/examples/include/latex/refman_doc.tex ("C:\Program Files\MiKTeX 2.9\te
x\latex\alertmessage\example.tex"
! LaTeX Error: Can be used only in preamble.
This is due to a \page command with the name 'example', renaming the page solves this issue.
|
|/
|
|
|
| |
- corrected tcl documentation in respect to use of param, has to be \param
- added to define documentation possibilities of \param and \return
|
| |
|
| |
|
|
|
|
|
|
|
|
| |
- doc/*.doc
use include instead of verbinclude to make use of the code coloring in the examples
- examples/*.cfg
some examples automatically display the code from the include file (*.h), for the examples it is better to show the comment as well.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Add the examples a shown in the HTML / CHM documentation also to the LaTeX / PDF documentation.
- doc/*.doc
added latexonly part referencing the example in the appendix
- doc/Doxyfile
silence the generation of the manual
- doc/doxygen_manual.tex
add the examples as appendices to the manual, by means of the subinputfrom command the parts included by refman_doc are taken from the specified directory
- examples/*.cfg
adjusted configuration files ("Doxyfile") to generate LaTeX output
- examples/*.h and examples/*.cpp
make names unique so no conflicts occur when adding all the examples
- examples/CMakeLists.txt
add generation of the file to be included (see strip_example.py), adjust dependencies and add the refman_doc.tex as output target
- examples/input_test.cpp
file added (adjusted copy of example_test.cpp) to overcome name clashes (example_test.cpp would have been included twice)
- examples/strip_example.py
we are only interested in the documentation files as included in the different examples, so we get those commands. The preamble will be handled by the doxygen_manual.tex and we have already an index in the doxygen_manual.tex so we don't need a separate one from each example.
The module / diagram documentation is dependent on the presence of 'dot', this is reflected in the docblocks.doc, CMakeLists.txt and doxygen_manual.tex
|
| |
|
|
|
|
|
|
| |
- made copying doc and example files a target
- fixed bug using temparary in the wizard.
- Added faq question about extension mapping
|
| |
|
| |
|
| |
|
| |
|
|
|
|
| |
Corrected some spelling errors and added / correceted some references
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|