summaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Fix typo in function nameThomas Braun2015-10-201-1/+1
| | | | | | As both declarations should only differ by cv-qualifiers. Signed-off-by: Thomas Braun <thomas.braun@byte-physics.de>
* Add examples to LaTeX / PDF doxygen manualalbert-github2015-09-064-23/+23
| | | | | | | | - 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-057-2/+179
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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
* Cmake tries to remove directory refman.tex instead of file refman.texalbert-github2015-08-301-1/+1
|
* Small documentation correctionsalbert-github2015-08-283-6/+8
| | | | | | - syntax correction - cross reference between HTML table and Markdown table - removed reference through "here" (problematic in printed documentation, one does not know where to go).
* Added documentation for creating tablesDimitri van Heesch2015-08-265-2/+101
|
* Fix for broken link in the manualDimitri van Heesch2015-08-081-2/+2
|
* docs: add examples as a dependency of docsAdrian Negreanu2015-08-021-9/+4
|
* Merge pull request #361 from groleo/man-pathDimitri van Heesch2015-07-261-1/+1
|\ | | | | doc: put man pages under share/man/man1
| * doc: put man pages under share/man/man1Adrian Negreanu2015-07-031-1/+1
| | | | | | | | | | | | | | | | | | 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
* | Merge branch 'master' of github.com:doxygen/doxygenDimitri van Heesch2015-07-181-1/+1
|\ \
| * | Updated italian translation and translator email addressAlessandro Falappa2015-07-161-1/+1
| | |
* | | doc: generate Doxygen's documentation.Adrian Negreanu2015-07-188-78/+162
|/ / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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]
* | Disable creating docs on Travis CI as the tabu package is missing on Ubuntu ↵Dimitri van Heesch2015-07-141-1/+2
| | | | | | | | 12.04
* | Redirect LaTeX output again to prevent filling the Travis CI logDimitri van Heesch2015-07-141-2/+1
| |
* | Merge branch 'master' of github.com:doxygen/doxygenDimitri van Heesch2015-07-141-6/+6
|\ \
| * | Fix spelling in doc/commands.doc (descriptionm)Étienne Simon2015-07-071-6/+6
| |/
* | Using tabu package for LaTeX tablesDimitri van Heesch2015-07-125-488/+38
|/
* Updated changelog for 1.8.10 releaseRelease_1_8_10Dimitri van Heesch2015-06-271-0/+152
|
* Updated installation section of the manualDimitri van Heesch2015-06-272-375/+41
|
* Various minor changesDimitri van Heesch2015-06-202-4/+23
| | | | | | - made copying doc and example files a target - fixed bug using temparary in the wizard. - Added faq question about extension mapping
* Added cmake rules to build the examples that are also part of the manualDimitri van Heesch2015-06-135-28/+27
|
* Build fixes for windows buildDimitri van Heesch2015-06-071-1/+1
|
* Fixes for running tests and generating docs with cmakeDimitri van Heesch2015-06-032-1/+2
|
* Fix for Travis CI build (attempt 10)Dimitri van Heesch2015-05-311-2/+8
|
* Fix for Travis CI build (attempt 8)Dimitri van Heesch2015-05-311-1/+1
|
* Cleanup & adapt travis configDimitri van Heesch2015-05-314-121/+1
|
* Removed old build files, added install targets and other optionsDimitri van Heesch2015-05-171-4/+60
|
* use cmakeAdrian Negreanu2015-05-151-0/+37
| | | | | | | | | | 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>
* Removed dbus XML parser, various refinementsDimitri van Heesch2015-05-151-154/+0
|
* Add support for basic XML syntax highlighting.Weston Thayer2015-05-151-0/+5
|
* Added documentation for ``` style fenced code block and more robust parsingDimitri van Heesch2015-04-051-0/+6
|
* Missing cross reference linkalbert-github2015-03-211-1/+1
| | | | Added cross reference link that was missing
* Merge branch 'master' of github.com:doxygen/doxygenDimitri van Heesch2015-02-262-5/+49
|\
| * Adding commands \hidecallgraph and \hidecallergraphalbert-github2015-02-222-5/+49
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | With the new commands \hidecallgraph and \hidecallergraph it is possible to suppress a call or caller graph even though the corresponding option CALL_GRAPH or CALLER_GRAPH is set. commands.doc config.xml diagrams.doc - updating documentation to support new commands entry.cpp - initialize callgraph and callergraph with the value from the config file commentscan.l - add handling for the new commands context.cpp memberdef.cpp util.cpp - getting the option for CALL_GRAPH and CALLER_GRAPH is not necessary anymore as it is incorporated in the initialization of an Entry item dbusxmlscanner.cpp - initialization is done in the Entry item vhdljjparser.cpp - gBlock was a static variable and therefore initialized before the doxygen main routine started. A Entry element sets now the default for callgraph and callergraph based on the config file and as the config file is not yet known at that moment the value for CALL_GRAPH and CALLER_GRAPH were set to False. By making a pointer of gBlock and doing an appropriate new Entry call this problem is overcome.
* | Bump copyright yearDimitri van Heesch2015-02-2632-33/+33
|/
* Merge branch 'master' of https://github.com/doxygen/doxygen.gitPetr Prikryl2015-01-052-2/+25
|\
| * Updated changelog for 1.8.9.1Dimitri van Heesch2015-01-041-0/+23
| |
| * Documentation HTML Header, Footer, and Stylesheet changesalbert-github2015-01-021-2/+2
| | | | | | | | Adjusted text to better reflect current situation.
* | Merge branch 'master' of https://github.com/doxygen/doxygen.gitPetr Prikryl2014-12-302-27/+261
|\ \ | |/
| * Updated changelog for release 1.8.9Release_1_8_9Dimitri van Heesch2014-12-251-0/+178
| |
| * various fixes and restructuringDimitri van Heesch2014-12-221-14/+11
| |
| * Limit images sizes and make more uniform (LaTeX)albert-github2014-11-281-24/+83
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This patch adjusts some problems regarding image sizes in LaTeX output of doxygen (a.o. Bug 738299 - When using msc or PlantUML, the default latex for the created image should include [width=\linewidth]) this has been done is such a way that all the "image" commands (i.e. image, dot, dotfile, msc, mscfile, diafile, startuml) operate in a similar way / have the same possibilities. - commands.doc Adjusted documentation to reflect changes. - cmdmapper.cpp - cmdmapper.h Added utility function to map command id back to command name - doctokenizer.h - doctokenizer.l Handle Caption and Size indication. Required also that some other rules had to be tightened a bit (like usage of {} in startuml and usage of "" for captions. This was already described in the documentation in this way). - docparser.cpp - docparser.h Created routine to uniformly handle the Caption and size indications and store them in a general way. - latexgen.cpp Replaced graphicx package by adjustbox package (includes graphicx) to support "min width" etc. - doxygen.sty templates\latex Added commands to make commands with and without caption behave similar. - docbookvisitor.cpp - docbookvisitor.h - htmldocvisitor.cpp - latexdocvisitor.cpp - latexdocvisitor.h - printdocvisitor.h - xmldocvisitor.cpp Created routine to uniformly handle the Caption and size indications in a general way. - indexpage.xml (testing\022) - indexpage.xml (testing\031) - class_receiver.xml (testing\037) - class_sender.xml (testing\037) Adjusted example output.
* | Merge branch 'master' of https://github.com/doxygen/doxygen.gitPetr Prikryl2014-09-241-1/+2
|\ \ | |/
| * Merge pull request #210 from albert-github/feature/snippet_from_current_fileDimitri van Heesch2014-08-261-1/+2
| |\ | | | | | | Create an easy possibility to take a snippet from the current file.
| | * Create an easy possibility to take a snippet from the current file.albert-github2014-08-151-1/+2
| | | | | | | | | | | | | | | | | | In case the snippet of code is in the current file one has to specify the name of the file and also see to it that the file is reachable through the EXAMPLE_PATH. A use case is the case of a list of initial values here it is quite often more convenient to have the values listed in a 'nice' list than direct in the definition line. With this patch it is possible to specify the name of the file where the snippet resides as: this
* | | Merge branch 'master' of https://github.com/doxygen/doxygen.gitPetr Prikryl2014-08-225-4/+231
|\ \ \ | |/ /
| * | Bug 734828 - Request: disable building documentation if Python 2.6 or newer ↵Release_1_8_8Dimitri van Heesch2014-08-211-1/+1
| | | | | | | | | | | | not available
| * | Preparations for release 1.8.8Dimitri van Heesch2014-08-211-0/+135
| | |
| * | Support multiple extra HTML stylesheets.albert-github2014-08-151-2/+2
| |/ | | | | | | | | | | In regular use it happens that it is more convenient to have multiple extra HTML stylesheets, e.g. in case of different levels of requirements: company, department, project With this patch it is possible to specify multiple HTML stylesheets. Note: for compatibility the configuration parameter HTML_EXTRA_STYLESHEET has not been renamed to HTM_EXTRA_STYLESHEETS.
generated by cgit v0.12 at 2024-10-30 08:30:41 (GMT)