summaryrefslogtreecommitdiffstats
path: root/examples
Commit message (Collapse)AuthorAgeFilesLines
* Doxygen's own documentation doesn't build with recent LaTeX versionalbert-github2020-12-1929-33/+94
| | | | | | | | | | | | | | | | | | | | | | | | | | | 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.
* Present all warnings of first documentation sub-task when it failsalbert-github2020-12-0428-28/+28
| | | | | 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.
* Have build of doxygen documentation fail on warnings.albert-github2020-11-2428-0/+28
| | | | | 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
* Allow building doxygen as a subprojectAnonymous Maarten2020-09-161-3/+3
|
* Remove support for TCL (code is too buggy and unmaintained, language not ↵Dimitri van Heesch2020-03-153-97/+0
| | | | very popular)
* CMake and examplesalbert-github2020-01-122-225/+45
| | | | | 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 for examples directoryalbert-github2019-11-041-2/+2
| | | | | | | 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.
* warning: Member func2InGroup1() (function) of class Memgrp_Test is not ↵albert-github2019-08-021-2/+2
| | | | | | | 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.
* Merge pull request #6957 from ↵Dimitri van Heesch2019-05-213-0/+68
|\ | | | | | | | | cfriedt/feature/cfriedt/6955/allow-javadoc-style-comment-blocks-with-a-doxyfile-variable Allow Javadoc-style comment blocks with a Doxyfile variable
| * Allow Javadoc-style comment blocks with a Doxyfile variableChristopher Friedt2019-05-033-0/+68
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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.
* | Bug 783759 - PERL_PATH config option: when is this needed? Still used?albert-github2019-05-071-1/+0
|/ | | | 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.
* Correcting tag example and uniform calling all examplesalbert-github2018-12-076-20/+12
| | | | | | - 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
* Spelling of the word Javadocalbert-github2018-10-291-1/+1
| | | | | The current spelling (also for the older versions) is Javadoc. Changed on all possible documentation visible places (external and internal).
* Changed mail address and removed obsolete filesDimitri van Heesch2018-09-022-92/+0
|
* Merge pull request #702 from albert-github/feature/bug_doxygen_docs_windowsDimitri van Heesch2018-05-211-1/+1
|\ | | | | Generating doxygen documentation on Windows (with MikTex)
| * Generating doxygen documentation on Windows (with MikTex)albert-github2018-04-111-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | 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.
* | Documentation correctionalbert-github2018-02-232-9/+11
|/ | | | | - corrected tcl documentation in respect to use of param, has to be \param - added to define documentation possibilities of \param and \return
* CMake: avoid if() around the whole contents of documentation CMakeLists.txtRolf Eike Beer2017-10-201-4/+0
|
* CMake: let file(MAKE_DIRECTORY) create all directories at onceRolf Eike Beer2017-10-201-2/+2
|
* Add examples to LaTeX / PDF doxygen manualalbert-github2015-09-068-0/+8
| | | | | | | | - 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 examples to LaTeX / PDF doxygen manualalbert-github2015-09-0542-143/+237
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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
* docs: add examples as a dependency of docsAdrian Negreanu2015-08-021-8/+10
|
* Various minor changesDimitri van Heesch2015-06-202-3/+12
| | | | | | - made copying doc and example files a target - fixed bug using temparary in the wizard. - Added faq question about extension mapping
* Fix for building diagram example conditionallyDimitri van Heesch2015-06-131-1/+5
|
* Added cmake rules to build the examples that are also part of the manualDimitri van Heesch2015-06-1330-97/+88
|
* Added cmake build targets for examplesDimitri van Heesch2015-06-083-251/+218
|
* Prevent example.tag from being regeneratedRelease_1_8_9_1Dimitri van Heesch2015-01-041-1/+1
|
* Documentation correctionsalbert-github2014-01-122-2/+2
| | | | Corrected some spelling errors and added / correceted some references
* Fixed regression in argument matching for the template exampleDimitri van Heesch2013-12-241-37/+38
|
* Release-1.8.3.1-20130324Dimitri van Heesch2013-03-241-30/+28
|
* Release-1.8.0-20120408Dimitri van Heesch2012-04-083-14/+15
|
* Release-1.7.6.1-20120220Dimitri van Heesch2012-02-201-0/+1
|
* Release-1.7.6.1-20120110Dimitri van Heesch2012-01-101-4/+4
|
* Release-1.7.6.1Dimitri van Heesch2011-12-101-0/+7
|
* Release-1.7.5.1-20111117Dimitri van Heesch2011-11-171-7/+0
|
* Release-1.7.5.1Dimitri van Heesch2011-08-211-1/+1
|
* Release-1.7.5Dimitri van Heesch2011-08-144-2/+105
|
* Release-1.7.4-20110606Dimitri van Heesch2011-06-061-13/+12
|
* Release-1.7.4Dimitri van Heesch2011-03-282-2/+9
|
* Release-1.7.1Dimitri van Heesch2010-06-2528-1/+29
|
* Release-1.6.0Dimitri van Heesch2009-08-201-1/+1
|
* Release-1.5.9-20090720Dimitri van Heesch2009-07-202-0/+88
|
* Release-1.5.6-20080727Dimitri van Heesch2008-07-274-4/+114
|
* Release-1.5.4-20080101Dimitri van Heesch2008-01-174-8/+61
|
* Release-1.5.4Dimitri van Heesch2008-01-161-1/+0
|
* Release-1.5.4Dimitri van Heesch2008-01-163-2/+5
|
* Release-1.4.6-20060327Dimitri van Heesch2006-03-271-1/+1
|
* Release-1.4.5-20051010Dimitri van Heesch2005-10-101-1/+1
|
* Release-1.4.4-20050806Dimitri van Heesch2005-08-068-6/+97
|
* Release-1.4.2-20050508Dimitri van Heesch2005-05-081-1/+2
|
generated by cgit v0.12 at 2024-06-01 21:53:19 (GMT)