summaryrefslogtreecommitdiffstats
path: root/doc/commands.doc
Commit message (Collapse)AuthorAgeFilesLines
* Merge pull request #8509 from albert-github/feature/bug_formula_mjDimitri van Heesch2021-05-011-0/+19
|\ | | | | Problems with some commands in MathJax
| * Problems with some commands in MathJaxalbert-github2021-04-201-0/+19
| | | | | | | | | | Especially with commands like `\f$\mbox{\LaTeX}\f$`MathJax has some problem as it is not, yet, able to use the commands `\raise` and `lower` inside the `\mbox` as used in this LaTeX command. Also switching in and out of math-mode doesn't work as the resulting code either doesn't work in MathJax or in LaTeX, hence the new command s `\f(` and `\f)`.
* | Spelling correctionalbert-github2021-05-011-1/+1
| | | | | | | | Small spelling correction
* | Merge branch 'feature/bug_startuml' of ↵Dimitri van Heesch2021-05-011-5/+17
|\ \ | | | | | | | | | https://github.com/albert-github/doxygen into albert-github-feature/bug_startuml
| * | Extending startuml with extra figure typesalbert-github2021-04-061-2/+2
| | | | | | | | | | | | | | | 2 more supported exgines / figure types: `board` and `git` (thanks to: The-Lu, see https://forum.plantuml.net/13557/support-for-the-different-%40start-commands?show=13564#a13564)
| * | Extending startuml with extra figure typesalbert-github2021-04-041-5/+17
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Not all diagrams can be created with the PlantUML `@startuml` command but need another PlantUML `@start...` command. This wil look like `@start<engine>` where currently supported are the following `<engine>`'s: `uml`, `bpm`, `wire`, `dot`, `ditaa`, `salt`, `math`, `latex`, `gantt`, `mindmap`, `wbs`, `yaml`, `creole`, `json` and `flow`. By default the `<engine>` is `uml`. The `<engine>` can be specified as an option. Explicitly the option variant has been chosen so we won't get an explosion of extra commands.
* | | Some documentation improvementsalbert-github2021-04-131-12/+51
| |/ |/| | | | | Some small documentation improvements.
* | remove a double "the"Olivier Couet2021-04-091-1/+1
| |
* | Remove a double "the"Olivier Couet2021-04-091-1/+1
| |
* | issue #2732: Adding support for C++ concepts (Origin: bugzilla #499352)Dimitri van Heesch2021-04-081-0/+10
|/
* Incorrect link in doxygen documentationalbert-github2020-12-031-1/+1
| | | | | The link to mathjax is not correct anymore (config.xml), the latest version points to version 3.0 and here there is no output.html either. Setting it fixed to the 2.7 version. The other corrected links are just about redirections that are otherwise done.
* Making the use of DOT_CLEANUP more transparentalbert-github2020-11-231-0/+9
| | | | | - The setting `DOT_CLEANUP` is not only used for `dot` files but also for temporary `msc` and `plantuml` files, though this was not clear from the documentation. - For the docbook output format the removal of the `dot` and `msc` files was not don like in the output formats html / LatTeX / rtf.
* Missing commands in list of commands documentationalbert-github2020-11-171-0/+2
| | | | | | | | | At the top of the chapter describing the commands there is a list with described commands, here the commands: ``` \noop \static ``` were missing.
* issue #7674: Mention EXTRACT_ALL in the context of /fileDimitri van Heesch2020-03-301-49/+49
|
* Mention EXTRACT_ALL in the context of /fileMoshe Kaplan2020-03-291-1/+2
|
* Adding commands `\rtfinclude`, `\docbookinclude`, `\maninclude` and ↵albert-github2020-01-091-6/+71
| | | | | | `\xmlinclude` Adding for consistency with `\*only`, `\htmlincclude` and `\latexinclude` the commands: `\rtfinclude`, `\docbookinclude`, `\maninclude` and `\xmlinclude`
* Showing information from all `*only commands in XML outputalbert-github2020-01-051-14/+21
| | | | This fix reverts the changes from #381 (i.e issue #4214 "htmlonly content appears in generated XML output (Origin: bugzilla 646002)", as XML is seen as an output format that can be further processed and therefore should contain all possible information.
* minor typo fixedReza Rastak2019-12-191-1/+1
|
* Textual erroralbert-github2019-10-061-4/+4
| | | | Correcting textual error
* 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-161-2/+2
|/
* Correction documentation `\image` commandalbert-github2019-08-301-3/+5
| | | | | - Correction supported formats for LaTeX - correction typo
* 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'
generated by cgit v0.12 at 2024-06-26 13:25:54 (GMT)