| Commit message (Collapse) | Author | Age | Files | Lines |
|
|
|
| |
Renaming index.chm to doxygen_manual.chm
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Until now the chm format of the doxygen documentation was generated by a separate script, this is now integrated in the CMake procedure.
- option -Dbuild_doc_chm to enable the possibility to generate the CHM documentation (only works for windows)
- procedure is as follows
- generate the base documentation for the CHM output
- copy the documentation of the examples to the tree with the base CHM output (cannot use it from its default place due to the fact that in the next face the first page of the CHM file will be wrong
- add the html, png, css and gif files of the examples to the so called hhp file (has to happen during runtime, hence a small python script, created inline so there is no extra file in the source tree)
- create the resulting doxygen_manual.chm
Some improvements during the process
- the html files of the examples are added so that the full documentation of the examples is accessible and not just the top pages of the examples
- keep the index terms of base chm file (mostly the commands and configuration parameters)
- see to it that the doxygen logo is copied by doxygen and not by means of cmake
|
| |
|
|
|
|
|
|
|
|
| |
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.
|
|
|
|
|
|
|
|
|
| |
The doxygen manual is not XHTML compliant.
In this, first, fix :
- fixes the problems in the doc files (note that docblocks has a small extra problem, pull request for this is #6660)
- determine output directory for HTML based on the doxyfile (for images).
Note: Remaining problems with examples and old change log files (version 1.5 and earlier)
|
|
|
|
|
|
| |
All translator function functions were mentioned as not used.
- the directory to find the places where the sources are that use translator functions was pointing to the src directory of the build tree instead the src directory in the source tree (source files are not copied) and thus finding no applicable sources.
- furthermore the test whether or not a function was based on the name of a function but in case a name is the short form of an other function and the longer name was not used it was still shown as used.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
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
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
|\
| |
| | |
doc: put man pages under share/man/man1
|
| |
| |
| |
| |
| |
| |
| |
| |
| | |
I found this on the Linux From Scratch page:
sed -i 's:man/man1:share/&:' ../doc/CMakeLists.txt
With this, the man pages are installed under ${PREFIX}/share/man/man1
http://www.linuxfromscratch.org/blfs/view/svn/general/doxygen.html
|
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| | |
* 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]
|
| |
| |
| |
| | |
12.04
|
| | |
|
|/ |
|
|
|
|
|
|
| |
- made copying doc and example files a target
- fixed bug using temparary in the wizard.
- Added faq question about extension mapping
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
|
runtest.pl replaced by testing/test_driver.cmake
version.py replaced by cmake/version.cmake
lang_cfg.py replaced by cmake/lang_cfg.cmake
settings.py implemented in src/CMakeLists.txt
increasebuffer.py replaced by defining the YY_BUF_SIZE and YY_READ_BUF_SIZE
Signed-off-by: Adrian Negreanu <adrian.m.negreanu@intel.com>
|