summaryrefslogtreecommitdiffstats
path: root/doc/commands.doc
Commit message (Collapse)AuthorAgeFilesLines
* 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.
* 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.
* 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 #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>`).
* | Show line numbers in "split" examplesalbert-github2019-03-031-1/+3
| | | | | | | | | | | | With the commands like `\skip`, `\skipline` it is possible to show parts of a file for further explanation / tutorials. They can be started with `\include` or `\dontinclude` but in case `\include` specifies that the line numbers have to be shown they are only shown in the full example and not in the split up example - show line numbers in split up example in case `lineno` is required - add `lineno` option to `\dontinclude` so here also line numbers can be shown.
* | Removed page restriction with `\anchor` command in documentationalbert-github2019-02-221-4/+0
|/ | | | The `\anchor` command can used on other places as well.
* Merge pull request #6684 from albert-github/feature/bug_broken_linksDimitri van Heesch2019-01-051-1/+1
|\ | | | | Broken links in documentation
| * Broken links in documentationalbert-github2018-12-161-1/+1
| | | | | | | | Fix broken links.
* | Merge branch 'feature/bug_escaped_equal_sign' of ↵Dimitri van Heesch2018-12-261-0/+9
|\ \ | | | | | | | | | https://github.com/albert-github/doxygen into albert-github-feature/bug_escaped_equal_sign
| * | Create command for escaped equal signalbert-github2018-11-071-0/+9
| | | | | | | | | | | | This command writes an equal sign (`=`) to the output. This character sequence has to be escaped in some cases, because it is used in Markdown header processing.
* | | Improved robustness of the emoji featureDimitri van Heesch2018-12-231-9/+17
| | | | | | | | | | | | | | | | | | | | | | | | 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.
* | | issue #6692 XML TOC generation is not backwards-compatible with 1.8.14albert-github2018-12-191-1/+1
| |/ |/| | | | | In case no options specified with the `\tableofcontents` `Html` and `XML` should be generated and not only `Html` (compatibility).
* | Doxygen manual is not XHTML compliantalbert-github2018-12-051-2/+0
| | | | | | | | | | | | | | | | | | 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)
* | Incorrect number tag sequence for xhtml with htmlinclude command possiblealbert-github2018-11-251-3/+12
| | | | | | | | | | | | Analogous to the `\htmlonly` also with the `\htmlinclude` command it is possible that some parts are added that cannot be inside a `<p> ... <\/p>` and thus we have to temporary close (and later reopen) the paragraph. The option `[block]` has been added to the `\htmlinclude` command (analogous to the `\htmlonly` command). Problem can be seen with the default doxygen test 30 (`[030_htmlinclude.dox]: test the \htmlinclude command`).
* | Merge branch 'feature/bug_inline_image' of ↵Dimitri van Heesch2018-11-111-1/+5
|\ \ | | | | | | | | | https://github.com/albert-github/doxygen into albert-github-feature/bug_inline_image
| * | Inline imagesalbert-github2018-08-091-1/+5
| | | | | | | | | | | | Create the possibility of inline images with the `\image` command by means of the option `inline`.
* | | Merge branch 'feature/issue_6517' of ↵Dimitri van Heesch2018-11-111-0/+9
|\ \ \ | |_|/ |/| | | | | https://github.com/albert-github/doxygen into albert-github-feature/issue_6517
| * | issue_6517: Emoji supportalbert-github2018-10-011-0/+9
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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
* | | Merge pull request #6562 from albert-github/feature/bug_referencesDimitri van Heesch2018-11-041-2/+73
|\ \ \ | | | | | | | | Add commands to handle referenced by relation and references relation
| * | | Add commands to handle referenced by relation and references relationalbert-github2018-10-301-25/+25
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Shortened the commands: - referencedbyrelation -> showrefby - hidereferencedbyrelation -> hiderefby - referencesrelation -> showrefs - hidereferencesrelation -> hiderefs
| * | | Add commands to handle referenced by relation and references relationalbert-github2018-10-171-3/+74
| |/ / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Analogous to call graph and caller graph this patch provides an implementation for the referenced by relation and references relation. Providing the commands: - referencedbyrelation - hidereferencedbyrelation - referencesrelation - hidereferencesrelation Motivation is that some lists can get extremely large and also there is now more symmetry between the textual and graphical out.
* | | Spelling of the word Javadocalbert-github2018-10-291-1/+1
|/ / | | | | | | | | The current spelling (also for the older versions) is Javadoc. Changed on all possible documentation visible places (external and internal).
* | addindex supports also DocBook and RTFalbert-github2018-09-161-3/+3
| | | | | | | | | | - addindex supports also DocBook and RTF - spelling of DocBook in documentation
* | Implementation of standard generator for docbook outputalbert-github2018-09-071-1/+1
| | | | | | | | | | | | | | | | Till now docbook had its own output generator, but lot of possibilities were missing (see remark about updating below), with this patch the (more than) basic implementation has been made. Added some docbook tests to the current tests and updated documentation where necessary Tried updating current version but too many issues remained that were generically handled in the standard generator, code is in current version behind '#if 0' construct in doxygen.cpp and name with '_v1' and in docbookgen.cp'
* | Documentation correction include command with optionsalbert-github2018-08-191-4/+4
| | | | | | | | | | - Corrected syntax - made text consistent
* | Bug 691689 - Line numbers for examplesDimitri van Heesch2018-08-191-36/+41
|/
* Minor documentation fixDimitri van Heesch2018-07-231-1/+1
|
* Merge branch 'feature/bug_tableofcontents_latex' of ↵Dimitri van Heesch2018-07-221-3/+11
|\ | | | | | | https://github.com/albert-github/doxygen into albert-github-feature/bug_tableofcontents_latex
| * Enable in page table of contents for XML and add maximum level to in page ↵albert-github2018-07-121-6/+10
| | | | | | | | | | | | | | table of contents - add the in page table of contents for XML - add the possibility to have maximum levels in the in page table of contents (possible per output type and per in page table of contents. Default is show all)
| * Enable in page table of contents for LaTeXalbert-github2018-05-211-3/+7
| | | | | | | | | | | | | | | | 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.)
* | Merge pull request #718 from albert-github/feature/bug_626105_docuDimitri van Heesch2018-07-181-1/+9
|\ \ | | | | | | Bug 626105 - @var in php is not documented
| * | Bug 626105 - @var in php is not documentedalbert-github2018-05-111-1/+9
| |/ | | | | | | Small clarification in case of datatype for php.
* | Bug 485773 - cond/endcond cannot be used in aliasesalbert-github2018-06-181-0/+4
|/ | | | Due to the moment of parsing \cond and \endcond cannot be used in ALIASES, added note to the documentation.
* Small documentation correctionsalbert-github2018-03-061-1/+1
|
* Spelling correctionalbert-github2017-09-021-1/+1
|
* Documentation, correct referenced filecosmichound2017-06-301-2/+2
|
* Correction of non reachable links and redirected links in documentation.albert-github2017-06-041-6/+6
| | | | | 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
|
* 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.
* Fix documentation typosJakub Wilk2016-02-021-1/+1
|
* Adjusted Doxygen to doxygen in running text in the manualDimitri van Heesch2016-01-031-3/+3
|
* Tweaked the htmlonly sections in the manual so it produces valid HTML outputDimitri van Heesch2015-12-261-26/+29
|
* Add examples to LaTeX / PDF doxygen manualalbert-github2015-09-061-14/+14
| | | | | | | | - 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-051-1/+57
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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
* Fix spelling in doc/commands.doc (descriptionm)Étienne Simon2015-07-071-6/+6
|
* Added cmake rules to build the examples that are also part of the manualDimitri van Heesch2015-06-131-15/+15
|
generated by cgit v0.12 at 2024-09-14 09:05:26 (GMT)