summaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Documentation, correct referenced filecosmichound2017-06-301-2/+2
|
* Correction of non reachable links and redirected links in documentation.albert-github2017-06-0412-44/+44
| | | | | The W3C link checker reported a number of problems regarding non reachable links and permanent redirects. Most of these problems have been fixed with this patch
* Corrected small typealbert-github2017-05-031-2/+2
|
* Adjust changelog in preparation for release 1.8.13Release_1_8_13Dimitri van Heesch2016-12-291-0/+64
|
* Bug 760678 - fails to build with an unreleased python versionDimitri van Heesch2016-12-241-3/+3
|
* Merge pull request #433 from albert-github/feature/docu_corr_433Dimitri van Heesch2016-12-102-5/+5
|\ | | | | Documentation small corrections
| * Documentation small correctionsalbert-github2015-12-272-5/+5
| |
* | Bug 774949 - Unknown reference in manualDimitri van Heesch2016-11-291-1/+1
| |
* | Bug 773231 - Underscores in type or member name cause unwanted hyphenation ↵Dimitri van Heesch2016-10-231-1/+1
| | | | | | | | in PDF output Data Fields
* | Add support for more CSS formatting and column/row spanning in markdown tablesjohnk2016-10-052-0/+114
| |
* | Updated changelog for 1.8.12 releaseRelease_1_8_12Dimitri van Heesch2016-09-051-0/+160
| |
* | Update copyright year in docsDimitri van Heesch2016-09-041-1/+1
| |
* | Bug 770660 - Code snippet always shows line numbers from 1albert-github2016-09-031-5/+14
| | | | | | | | | | | | | | | | | | This patch makes the handling of the \snippet and other commands consistent between the different languages (no line numbers anymore with python) and also introduces analogous to \includelineno the command \snippetlineno. Some non relevant changes: - *code.l Calculation of the end line was incorrect, in case of a snippet the end line was the number of lines of the snippet and not reltive to the start line. - *code.l made consistent over the different laguages, enabling exBlock and inlineFragment - testing/indexpage.xml in test 14 the \snippet command was used with python and giving line numbers, linenumbers are now gone (consistency)
* | Introducing commands includedoc and snippetdocalbert-github2016-08-211-4/+40
| | | | | | | | | | Purpose to have the possibility to have repeating texts not repeated in the comments. The commands include and snippet introduce code blocks whilst the commands includedoc and snippetdoc inclode the text as is and it will be parsed by doxygen.
* | Documentation for extensions .f95, .f03 and .f08albert-github2016-08-211-0/+3
| | | | | | | | Added documentation for pull request #495
* | Fix issue escaping backslash inside markdown style code spanDimitri van Heesch2016-07-231-1/+1
| |
* | Updated stylesheet for the manual to fix layout issue in the navigation treeDimitri van Heesch2016-06-021-171/+568
| |
* | Minor build fixesDimitri van Heesch2016-05-091-2/+2
| |
* | Fix Windows build instructions.Christoph Lipka2016-04-131-1/+1
| |
* | Fix documentation typosJakub Wilk2016-02-026-56/+55
| |
* | PDF generation stops when image with caption is included in a table.albert-github2016-01-151-0/+7
| | | | | | | | | | - patch should only be applied to images. - added doxyfigcaption to manual.sty for completeness, when in future a table with an image and caption might appear in the documentation.
* | 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.
* | Adjusted Doxygen to doxygen in running text in the manualDimitri van Heesch2016-01-0311-36/+36
| |
* | Minor update to the installation instructionsDimitri van Heesch2015-12-311-2/+3
| |
* | Updated changelog for 1.8.11Release_1_8_11Dimitri van Heesch2015-12-291-0/+157
|/
* Tweaked the htmlonly sections in the manual so it produces valid HTML outputDimitri van Heesch2015-12-266-1179/+1229
|
* Fix error documentation of in flex debug scriptDimitri van Heesch2015-12-201-2/+2
|
* Updated instructions to toggle debugging flex codeDimitri van Heesch2015-12-131-25/+20
|
* 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
|