summaryrefslogtreecommitdiffstats
path: root/doc/doxygen_manual.tex
Commit message (Collapse)AuthorAgeFilesLines
* Latex page numberingalbert-github2016-01-091-1/+2
| | | | | | In the documentation generated by doxygen the table of contents does not start with page number i but with iii, by setting the pagenumbering}{roman} after the clearemptydoublepage titlepage this is corrected. In the beginning of the documentation we set the page numbering to "alph" so it won't interfere with the numbers in the table of contents and the real documentation. For the doxygen manual similar reasoning is true, furthermore the table of contents was on the left side page (when printed double sided), yhis is corrected as well.
* Add examples to LaTeX / PDF doxygen manualalbert-github2015-09-051-0/+66
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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
* Added documentation for creating tablesDimitri van Heesch2015-08-261-0/+3
|
* doc: generate Doxygen's documentation.Adrian Negreanu2015-07-181-1/+2
| | | | | | | | | | | | | | | | | | * use configure_files to avoid different $ semantics when COMMAND lines are expanded in build files. ($$var vs. \$var) * nmake/gmake no longer needed by cmake, when building doc. * explicitly copy doc files into build directory to make it clear what files each build stage uses. Documentation can be built with: mkdir build/ && cd $_ cmake -Dbuild_doc=1 .. # add -G"NMake Makefiles" for nmake make docs # this builds doxygen first v3: replace file(COPY) with proper generated file tagging. v2: Remove option to build documentation independently from doxygen. tested on linux(gmake) and windows(nmake) [thanks albert]
* Using tabu package for LaTeX tablesDimitri van Heesch2015-07-121-0/+1
|
* Bump copyright yearDimitri van Heesch2015-02-261-1/+1
|
* Updated copyrightDimitri van Heesch2014-02-111-1/+1
|
* Recognize all HTML4 special character entitiesalbert-github2014-02-081-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | In doxygen a limited number of HTML4 special character entities are recognized, with this patch the full list of HTML4 special character entities (see http://www.w3.org/TR/html4/sgml/entities.html) is supported (as far as they can be represented in the output format). - doxygen_manual.tex - latexgen.cpp Added wasysym package to support per thousand sign (perthousand command from textcomp didn't work properly) Added option for textcomp package so currency symbol would work properly - htmlcmds.doc Adjusted documentation, listing all entities - compound.xsd - xmlgen.cpp Removed in xsd file all references for special HTML4 character entities and placed placeholder so doxygen (in xmlgen.cpp)can automatically add the right element names. - util.cpp - util.h Define all entities with their representation for all output formats. Define access routines to the different representations Mapping (for recognition of the entities) based on running through the list of available entities, after validation of the order of the entities. A few entities contain now besides letters also numbers at the end. - docparser.h Define symbols for all entities as well as a helper struct and enum. The member m_letter is not used anymore and thus removed. All existing symbols were renamed so no confusion (i.e. errors when forgetting to rename some symbols) can occur. Obsolete references to letter removed, all letters with accents etc. are explicitly defined and not through the generic accent name plus an extra letter. - docparser.cpp Adjust used symbols to their new names. Remove references to letter (as used for accents etc.) Replace list of explicitly supported entities with call to symbol code access routine. - docbookvisitor.cpp - htmldocvisitor.cpp - latexdocvisitor.cpp - mandocvisitor.cpp - perlmodgen.cpp - printdocvisitor.h - rtfdocvisitor.cpp - textdocvisitor.cpp - xmldocvisitor.cpp Replace list of explicitly supported entities with call to access routine and use returned value to output.
* Added missing \+ command to build LaTeX manualDimitri van Heesch2014-01-191-0/+1
|
* Bug 707483 - Wrong page number and header in pdf outputDimitri van Heesch2013-09-091-1/+2
|
* Release-1.8.3.1-20130512Dimitri van Heesch2013-05-121-1/+1
|
* Release-1.8.3.1Dimitri van Heesch2013-01-201-1/+1
|
* Release-1.8.3Dimitri van Heesch2012-12-261-0/+1
|
* Release-1.8.1.2Dimitri van Heesch2012-07-121-0/+1
|
* Release-1.7.6.1-20120220Dimitri van Heesch2012-02-201-1/+2
|
* Release-1.7.6.1-20120122Dimitri van Heesch2012-01-221-1/+2
|
* Release-1.7.6.1-20120110Dimitri van Heesch2012-01-101-12/+35
|
* Release-1.7.5.1-20111117Dimitri van Heesch2011-11-171-1/+0
|
* Release-1.7.3-20110123Dimitri van Heesch2011-01-231-1/+1
|
* Release-1.7.1-20100728Dimitri van Heesch2010-07-281-1/+2
|
* Release-1.7.0Dimitri van Heesch2010-06-151-1/+1
|
* Release-1.6.3-20100507Dimitri van Heesch2010-05-071-4/+4
|
* Release-1.6.1-20091222Dimitri van Heesch2009-12-221-4/+5
|
* Release-1.5.9-20090814Dimitri van Heesch2009-08-141-1/+1
|
* Release-1.5.6-20080914Dimitri van Heesch2008-09-141-1/+5
|
* Release-1.5.6-20080819Dimitri van Heesch2008-08-191-0/+1
|
* Release-1.5.6Dimitri van Heesch2008-05-181-27/+27
|
* Release-1.5.1-20070219Dimitri van Heesch2007-02-191-2/+2
|
* Release-1.4.6-20060507Dimitri van Heesch2006-05-071-2/+2
|
* Release-1.4.6-20060227Dimitri van Heesch2006-02-271-0/+1
|
* Release-1.3.8-20040803Dimitri van Heesch2004-08-031-2/+2
|
* Release-1.3.5-20040105Dimitri van Heesch2004-01-051-2/+2
|
* Release-1.3.3-20030909Dimitri van Heesch2003-09-091-1/+0
|
* Release-1.3-20030514Dimitri van Heesch2003-05-141-1/+1
|
* Release-1.3-rc2-20030119Dimitri van Heesch2003-01-191-2/+2
|
* Release-1.2.18-20021030Dimitri van Heesch2002-10-301-0/+2
|
* Release-1.2.16-20020623Dimitri van Heesch2002-06-231-2/+1
|
* Release-1.2.16Dimitri van Heesch2002-05-201-2/+3
|
* Release-1.2.14-20020310Dimitri van Heesch2002-03-101-2/+2
|
* Release-1.2.10-20010923Dimitri van Heesch2001-09-231-0/+1
|
* Release-1.2.10-20010909Dimitri van Heesch2001-09-091-0/+3
|
* Release-1.2.4-20010107Dimitri van Heesch2001-01-071-2/+2
|
* Release-1.2.4Dimitri van Heesch2000-12-241-1/+1
|
* Release-1.2.3-20001217Dimitri van Heesch2000-12-171-0/+1
|
* Release-1.2.1Dimitri van Heesch2000-08-131-0/+2
|
* Release-1.2.0-20000730Dimitri van Heesch2000-07-301-2/+1
|
* Release-1.1.5-20000716Dimitri van Heesch2000-07-161-0/+1
|
* Release-1.1.3Dimitri van Heesch2000-05-081-0/+1
|
* Release 2000-04-03Dimitri van Heesch2000-04-031-1/+2
|
* Release-1.1.1-20000326Dimitri van Heesch2000-03-261-1/+1
|