summaryrefslogtreecommitdiffstats
path: root/examples
Commit message (Collapse)AuthorAgeFilesLines
* 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
|
* Release-1.3.7-20040718Dimitri van Heesch2004-07-181-0/+1
|
* Release-1.3.7-20040617Dimitri van Heesch2004-06-171-1/+0
|
* Release-1.3.5-20040105Dimitri van Heesch2004-01-051-1/+2
|
* Release-1.3-rc1Dimitri van Heesch2002-11-153-12/+14
|
* Release-1.2.15Dimitri van Heesch2002-04-011-0/+7
|
* Release-1.2.13Dimitri van Heesch2001-12-291-0/+1
|
* Release-1.2.11Dimitri van Heesch2001-09-301-3/+3
|
generated by cgit v0.12 at 2024-11-06 18:16:32 (GMT)