| Commit message (Collapse) | Author | Age | Files | Lines |
|---|
| |
|
|
| |
very popular)
|
| |
|
|
| |
Small problem with defining `\hrulefilll`, moved code.
|
| |
|
|
|
|
|
| |
The definition of `\doxysection` etc. are using grouping around the section title, and this destroys the \label system as label names are stored locally.
(see also: https://tex.stackexchange.com/questions/502650/section-numbering-in-redefined-sections)
the `\doxysection` commands have been redefined (unfortunately partly copying values from book.cls)
|
| |
|
|
|
| |
Based on comment `\usepackage` in refman.tex / doxygen_manual.tex has been replaced with `\RequirePackage` in doxygen.sty
("back to its old place").
|
| |
|
|
|
| |
Created a workaround for the problems in the unmaintained tabu package due to changes in LaTeX 2019
Changes are based on the comments of David Carlisle and Frank Mittelbach of The LaTeX3 Project Team
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
The 1.8.15 manual had 26 examples but due to the fact that a new example was created we got 27 and thus the characters A-Z are not sufficient.
In a number of LaTeX versions this leads to messages like:
```
Appendix \GenericError { }{LaTeX Error: Counter too large}{See th
e LaTeX manual or LaTeX Companion for explanation.}{You've lost some text. Try
typing <return> to proceed.\MessageBreak If that doesn't work, type X <retu
rn> to quit.}.
! LaTeX Error: Counter too large.
```
Solution for this is to reorganize the examples a little bit. This is done here by means of the "groups":
- Style examples
- Language Examples
as a consequence also the sections / subsections etc had to go 1 level deeper and this is accomplished by defining a new environment in which the different sections go 1 level deeper.
|
| | |
|
| | |
|
| |
|
|
|
|
|
|
| |
Changes:
- Use of `@emoji name` instead of `:name:`
- Support only GitHub emojis (i.e. without spaces or special characters in the name)
- Provided script to download images for LaTeX support.
- XML output now has <emoji> tag with name an unicode sequence.
|
| |
|
|
|
| |
Synchronize names of chapters of doxygen's own documentation between HTML output and LaTeX output.
Corrected a small error regarding wrong tag in documentation ('<--' -> '<!--')
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Added issue support for the different output types.
- Sources of the emoji
- based on the Unicode definition v11.0:
- https://unicode.org/emoji/charts/full-emoji-list.html
- http://www.unicode.org/emoji/charts/full-emoji-modifiers.html
- github definition list:
- https://api.github.com/emojis
- Input of emoji: :<test>: with the restriction that direct after the opening colon and direct before the closing colon no space is allowed
- doctokinizer.l, adding detection of emoji and new command `\:`
- doktokinizer.h, adding "word" type TK_EMOJI
- docparser.* handling of new "word" type TK_EMOJI (analogous to HTML Entities), handling of new command `\:`
- cmdmapper,cpp, cmdmapper.h, adding new command `\:`
- htmlentity.cpp, adding new definition required for new command `\:`
- Emoji
- emoji.cpp, emoji.h, class for handling emoji analogous to HTML Entities, including small directions on how to update the code when a new emoji is defined. Not everything is converted to lowercase for comparison and accents are removed.
- doxygen.cpp possibility to create list of supported emoji
- handling emoji for output types (analogous to HTML Entities), see documentation for different output types
- docparser.h, *docvisitor.*
- rtfdocvisitor.* converting output to UTF-16 (based on http://scruss.com/blog/2017/03/12/in-the-unlikely-event-you-need-to-represent-emoji-in-rtf-using-perl/)
- latexdocvisitor.*, handling arguments for emoji in output (see also latexgen.cpp for meaning of the arguments of doxygenemoji).
- latexgen.cpp, adding new latex command for doxygen (doxygenemoji) and prevent too many open file (code before documentclass)
- config.xml, definition of `LATEX_EMOJI_DIRECTORY` with path to images required for LaTeX output
- Documentation:
- emojisup.doc, user description
- commands.doc, description of new command `\:`
- index.doc, reference to emoji chapter
- xmlcmds.doc, adjust reference to next chapter as a new chapter is added
- Doxyfile*, adding emoji chapter
Build system
- CMakeLists.txt adding new files
|
| |
|
|
|
|
|
|
| |
currently the \tableofcontents command is only supported for HTML.
In this patch:
- enable in page table of contents for LaTeX: \tableofcontents['{'[option][,option]*'}']
where option can be 'HTML, and 'LaTeX'
(side effect: possibility to have options with, nearly, all commands.)
|
| |
|
|
|
|
| |
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 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
|
| | |
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
* 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]
|
| | |
|
| | |
|
| | |
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
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.
|
| | |
|
| | |
|
| | |
|
| | |
|
| | |
|
| | |
|
| | |
|
| | |
|
| | |
|
| | |
|
| | |
|
| | |
|
| | |
|
| | |
|
| | |
|
| | |
|
| | |
|
| | |
|
| | |
|
| | |
|
| | |
|
| | |
|
| | |
|
| | |
|
| | |
|
| | |
|
| | |
|
| | |
|
| | |
|
| | |
|
