summaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Merge pull request #7293 from albert-github/feature/bug_doc_cmdDimitri van Heesch2019-11-261-4/+4
|\ | | | | Textual error
| * Textual erroralbert-github2019-10-061-4/+4
| | | | | | | | Correcting textual error
* | Adding some links in search documentationalbert-github2019-11-251-4/+5
| | | | | | | | The search chapter was missing some links
* | Spelling corrections for doc directoryalbert-github2019-11-043-153/+153
| | | | | | | | | | | | | | Spelling corrections as found by codespell and in #561. Some reported problems were already fixed, others are fixed here. Theer are a few that are not corrected as they signal a documentation correction.
* | Merge pull request #7332 from albert-github/feature/bug_rtf_manDimitri van Heesch2019-10-281-10/+18
|\ \ | | | | | | RTF extension file to standard output, make according documentation consistent.
| * | RTF extension file to standard output, make according documentation consistent.albert-github2019-10-171-10/+18
| |/ | | | | | | | | Create possibility to write rtf extension file to standard output as well, see to it that same technique is used on different places Update documentation and make it consistent
* | Support for <a id="label">albert-github2019-10-161-0/+2
|/ | | | Support besides `<a name="label">` also `<a id="label">` as `id=` is the HTML attribute to define an ad for an HTML element.
* Merge pull request #7264 from albert-github/feature/bug_164073Dimitri van Heesch2019-09-161-0/+7
|\ | | | | Bug 164073 - There should be a dummy tag that Doxygen ignores
| * Bug 164073 - There should be a dummy tag that Doxygen ignoresalbert-github2019-09-151-0/+7
| | | | | | | | Introduced the `\noop` command to ignore text till end of the line.
* | Fix some typos luz.paz2019-09-163-4/+4
|/
* Merge pull request #7179 from albert-github/feature/bug_doxygen_docu_chmDimitri van Heesch2019-09-013-13/+70
|\ | | | | Generating doxygen's documentation in CHM format
| * Generating doxygen's documentation in CHM formatalbert-github2019-08-111-0/+1
| | | | | | | | Renaming index.chm to doxygen_manual.chm
| * Generating doxygen's documentation in CHM formatalbert-github2019-08-113-13/+69
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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
* | Merge pull request #7239 from albert-github/feature/bug_docu_imageDimitri van Heesch2019-08-311-3/+5
|\ \ | | | | | | Correction documentation `\image` command
| * | Correction documentation `\image` commandalbert-github2019-08-301-3/+5
| | | | | | | | | | | | | | | - Correction supported formats for LaTeX - correction typo
* | | Merge pull request #7234 from albert-github/feature/bug_copyrightDimitri van Heesch2019-08-312-2/+2
|\ \ \ | |/ / |/| | Correcting visible year in copyright
| * | Correcting visible year in copyrightalbert-github2019-08-282-2/+2
| | | | | | | | | | | | Correcting another visible year in copyright (see also #7182)
* | | issue #7218 Doxygen parsing word documentsalbert-github2019-08-231-0/+1
|/ / | | | | | | | | making list consistent again. See also table in chapter "Getting Started"
* | Order of commands in `<table>`albert-github2019-08-121-0/+2
|/ | | | Added note about the order of caption versus table rows and the number of table rows.
* Missing tables item in overviewalbert-github2019-08-101-0/+1
| | | | In the overview the paragraph about 'tables' is missing
* (X)HTML errors in 1.8.16 changelogalbert-github2019-08-091-3/+8
| | | | Corrected the (X)HTML errors in the 1.8.16 changelog
* Merge branch 'master' of github.com:doxygen/doxygenRelease_1_8_16Dimitri van Heesch2019-08-082-3/+3
|\
| * Fixing redirection linksalbert-github2019-08-082-3/+3
| | | | | | | | | | Fixing a number of redirecting links in the doxygen documentation. (Note the redirects from http://www.doxygen.org to http://www.doxygen.nl are not corrected)
* | Update changelog for release 1.8.16Dimitri van Heesch2019-08-081-0/+336
|/
* Merge pull request #7097 from albert-github/featre/bug_437181Dimitri van Heesch2019-08-041-0/+4
|\ | | | | Bug 437181 - The -d Preprocessor option doesn't work for php, should be in the doc.
| * Bug 437181 - The -d Preprocessor option doesn't work for php, should be in ↵albert-github2019-07-021-0/+4
| | | | | | | | | | | | | | the doc. - excluded `.php5` files from preprocessing (like other php files) - made remark about some limits in files that are preprocessed in documentation
* | Incorrect paragraph numbers in secref list.albert-github2019-08-041-4/+23
| | | | | | | | | | | | | | 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)
* | Merge branch 'fetaure/bug_html_ins_del_tag' of ↵Dimitri van Heesch2019-08-031-0/+4
|\ \ | | | | | | | | | https://github.com/albert-github/doxygen into albert-github-fetaure/bug_html_ins_del_tag
| * | Adding HTML tags ins and delalbert-github2019-04-041-0/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Github does not support the `<u>` tag for underlined text, in HTML there exists the tag `<ins>`. On https://www.w3schools.com/tags/tag_ins.asp is written: The `<ins>` tag defines a text that has been inserted into a document. Browsers will normally strike a line through deleted text and underline inserted text. Most browsers will display the `<ins>` element with the following default values: ``` ins { text-decoration: underline; } ``` analogous there exists the tag `<del>` (https://www.w3schools.com/tags/tag_del.asp): The `<del>` tag defines text that has been deleted from a document. Browsers will normally strike a line through deleted text and underline inserted text. Most browsers will display the `<del>` element with the following default values: ``` del { text-decoration: line-through; } ``` Definitions analogue to the underline and strike through tag the implementation for the other formats has been chosen.
* | | warning: Member func2InGroup1() (function) of class Memgrp_Test is not ↵albert-github2019-08-021-1/+1
| | | | | | | | | | | | | | | | | | | | | documented. Correcting code due to the fact that `//@{` isn't seen by doxygen as block start (#7116). Thi s problem is shown when generating the doxygen documentation.
* | | issue #6769 Tabu is brokenalbert-github2019-07-261-6/+2
| | | | | | | | | | | | | | | Based on comment `\usepackage` in refman.tex / doxygen_manual.tex has been replaced with `\RequirePackage` in doxygen.sty ("back to its old place").
* | | issue #6769 Tabu is brokenalbert-github2019-07-221-1/+13
| | | | | | | | | | | | | | | 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
* | | Option for 'input buffer overflow'albert-github2019-07-201-0/+7
| | | | | | | | | | | | Cmake option `-Denlarge_lex_buffers=<size>` to enlarge input and read buffers for source code lexers.
* | | Merge pull request #7112 from arm-in/masterDimitri van Heesch2019-07-202-2/+2
|\ \ \ | | | | | | | | Correct spelling "build in" vs. "built-in"
| * | | built-inArmin Müller2019-07-091-1/+1
| | | |
| * | | built-inArmin Müller2019-07-091-1/+1
| | | |
* | | | Bug 642126 - @mscfile <filename> does not process mscgen codealbert-github2019-06-271-1/+6
| |_|/ |/| | | | | | | | Small explanation about required syntax.
* | | Update documentation for mscalbert-github2019-06-261-3/+2
| | | | | | | | | | | | Due to the built in mscgen code the documentation needed some updates.
* | | More than 26 appendices in LaTeX manualalbert-github2019-05-231-16/+44
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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.
* | | Merge pull request #6957 from ↵Dimitri van Heesch2019-05-212-0/+21
|\ \ \ | | | | | | | | | | | | | | | | cfriedt/feature/cfriedt/6955/allow-javadoc-style-comment-blocks-with-a-doxyfile-variable Allow Javadoc-style comment blocks with a Doxyfile variable
| * | | do not clobber version placeholderChristopher Friedt2019-05-181-1/+1
| | | |
| * | | updated manual, included examples in documentationChristopher Friedt2019-05-172-1/+12
| | | |
| * | | add blurb to docblocksChristopher Friedt2019-05-091-0/+10
| | | |
* | | | Bug 783759 - PERL_PATH config option: when is this needed? Still used?albert-github2019-05-071-1/+0
|/ / / | | | | | | | | | As, more or less, mentioned in the bug report: in version 1.7.6.1 the PERL_PATH is still in use (instdox.cpp) but in version 1.8.0 it is not used anymore, so the parameter has been set to obsolete now.
* | | Option syntax for commands is unclearalbert-github2019-04-201-1/+1
| | | | | | | | | | | | Corrected typo
* | | Option syntax for commands is unclearalbert-github2019-04-171-16/+21
| |/ |/| | | | | Making documentation regarding option clearer and more consistent.
* | Merge pull request #6784 from albert-github/feature/issue_6781_2Dimitri van Heesch2019-03-171-3/+3
|\ \ | | | | | | issue #6781 Unable to use math in markdown table headers
| * | issue #6781 Unable to use math in markdown table headersalbert-github2019-01-191-3/+3
| | | | | | | | | | | | | | | | | | Due to the change of the place where the markdown processing is done the end of the line must be calculated a little bit differently. Note: translator.py gave an error due to a strange indentation (did surface now), so had to be corrected as well.
* | | Merge pull request #6853 from albert-github/feature/bug_superfluous_par_tagsDimitri van Heesch2019-03-101-15/+13
|\ \ \ | | | | | | | | Remove superfluous paragraph tags
| * | | Remove superfluous paragraph tagsalbert-github2019-02-231-15/+13
| | | | | | | | | | | | | | | | Removed some superfluous paragraph tags in HTML (`</p>`).