summaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Merge branch 'feature/issue_6517' of ↵Dimitri van Heesch2018-11-117-2/+181
|\ | | | | | | https://github.com/albert-github/doxygen into albert-github-feature/issue_6517
| * issue_6517: Emoji supportalbert-github2018-10-017-2/+181
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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-294-9/+9
| | | | | | | | | | | | | | | The current spelling (also for the older versions) is Javadoc. Changed on all possible documentation visible places (external and internal).
* | | Documentation internet addressesalbert-github2018-10-277-12/+13
|/ / | | | | | | Running a link checker revealed a number of not existing / redirected addresses, these have been corrected.
* | issue_6524: Markdown formats missing in doxygen outputs.albert-github2018-10-021-7/+18
|/ | | | | | Support for strikethrough by means of `~~<text>~~` See also https://help.github.com/articles/basic-writing-and-formatting-syntax/ paragraph about "styling" text".
* addindex supports also DocBook and RTFalbert-github2018-09-162-4/+4
| | | | | - addindex supports also DocBook and RTF - spelling of DocBook in documentation
* Merge pull request #6487 from albert-github/feature/bug_docbookDimitri van Heesch2018-09-151-1/+1
|\ | | | | Implementation of standard generator for docbook output
| * 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'
* | Merge pull request #6510 from albert-github/feature/doxyfile_differncesDimitri van Heesch2018-09-152-1/+19
|\ \ | | | | | | Difference between standard and used Doxyfile
| * | Difference between standard and used Doxyfilealbert-github2018-09-152-1/+19
| | | | | | | | | | | | | | | | | | Writes a the differences between the current configuration and the template configuration. Useful when communicating e.g. in forums.
* | | Usage of '{', '}' and ',' in ALIASalbert-github2018-09-141-0/+5
|/ / | | | | | | | | | | | | | | | | | | | | | | | | Based on the stack overflow question: https://stackoverflow.com/questions/52314045/how-to-use-addtogroup-with-an-aliases-command/52314821#52314821 ALIASES += opengroup{1}="^^* \addtogroup \1_GROUP ^^ * \{ ^^" ALIASES += close="\}" /** \opengroup{LEVEL_1} */ // ...code statements... /** \close */ // opengroup Does not create a group due to the change of `\{` to just `}`, this behavior has been documented now.
* | Update install.doc: Qt 5 is now supported as wellMichael "Croydon" Keck2018-09-111-5/+5
| |
* | Small correction installation / build procedurealbert-github2018-09-091-0/+5
|/ | | | | - Adding some indices - Adding python requirement for *nix
* Merge pull request #6468 from arm-in/masterDimitri van Heesch2018-09-031-2/+2
|\ | | | | Typos found by running "codespell"
| * Update changelog.docArmin Müller2018-08-211-2/+2
| |
* | Update mail addressDimitri van Heesch2018-09-014-6/+6
| |
* | Merge branch 'feature/bug_667993' of ↵Dimitri van Heesch2018-08-261-0/+4
|\ \ | | | | | | | | | https://github.com/albert-github/doxygen into albert-github-feature/bug_667993
| * | Bug 667993 - HTML tags <u> and </u> not supportedalbert-github2018-07-151-1/+0
| | | | | | | | | | | | Removed redundant line in documentation
| * | Bug 667993 - HTML tags <u> and </u> not supportedalbert-github2018-07-071-0/+5
| | | | | | | | | | | | Added underline possibility and strike through possibility for the different output formats insofar it is possible (other similar possibilities are not always possible for all output formats either).
* | | Merge pull request #6441 from albert-github/feature/bug_distributed_manDimitri van Heesch2018-08-213-5/+5
|\ \ \ | |_|/ |/| | Small corrections in distributed man pages
| * | Small corrections in distributed man pagesalbert-github2018-08-133-5/+5
| | |
* | | 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
|/ /
* | Merge pull request #6398 from albert-github/feature/bug_610436Dimitri van Heesch2018-07-251-0/+3
|\ \ | | | | | | Bug 610436 - <![CDATA[ is not handled inside C# comments
| * | Bug 610436 - <![CDATA[ is not handled inside C# commentsalbert-github2018-07-191-0/+3
| | | | | | | | | | | | Added handling of "<![CDATA[ ... ]]>" i.e. XML CDATA sections in an analogous way top HTML comment but in this case the text is retained (as normal doxygen comment) and the special XML characters `<`,`>` and `&` are taken as if they were escaped.
* | | Merge pull request #760 from albert-github/feature/bug_754440Dimitri van Heesch2018-07-231-1/+6
|\ \ \ | | | | | | | | Bug 754440 - Can't suppress @author, @date and @copyright informationin the detailed file description
| * | | Bug 754440 - Can't suppress @author, @date and @copyright information in the ↵albert-github2018-06-101-1/+6
| | | | | | | | | | | | | | | | | | | | | | | | detailed file description Small clarification regarding `authorsection` versus `\author`
* | | | Minor documentation fixDimitri van Heesch2018-07-231-1/+1
| | | |
* | | | Merge branch 'feature/bug_tableofcontents_latex' of ↵Dimitri van Heesch2018-07-2210-12/+25
|\ \ \ \ | |_|/ / |/| | | | | | | https://github.com/albert-github/doxygen into albert-github-feature/bug_tableofcontents_latex
| * | | Merge branch 'feature/bug_tableofcontents_latex' of ↵albert-github2018-07-122-6/+5
| |\ \ \ | | | | | | | | | | | | | | | https://github.com/albert-github/doxygen into feature/bug_tableofcontents_latex
| | * \ \ Merge branch 'master' into feature/bug_tableofcontents_latexDimitri van Heesch2018-06-242-6/+5
| | |\ \ \
| * | | | | 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-2110-12/+21
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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.
* | | | | Merge pull request #769 from albert-github/feature/bug_485773_docuDimitri van Heesch2018-07-071-0/+4
|\ \ \ \ \ | |_|_|_|/ |/| | | | Bug 485773 - cond/endcond cannot be used in aliases
| * | | | 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.
* | | | Fixed bug in URLDimitri van Heesch2018-07-031-1/+1
| | | |
* | | | Fixed documentation to point to GitHub issue trackerDimitri van Heesch2018-07-023-1124/+1123
| |_|/ |/| |
* | | Resolve inconsistency in formula repositories.albert-github2018-06-111-2/+2
|/ / | | | | | | HTML and RTF have their own directory with formula repository files. These can get out of sync when HTML and RTF versions are not always build together (and both are required again).
* | Merge pull request #750 from ↵Dimitri van Heesch2018-06-101-1/+1
|\ \ | | | | | | | | | | | | albert-github/feature/doxygen_html_manual_markdown_tables Doxygen manual doesn't have lines around markdown tables / cells.
| * | Doxygen manual doesn't have lines around markdown tables / cells.albert-github2018-05-291-1/+1
| |/ | | | | | | | | | | | | In the chapter about markdown tables the tables lack the lines around the table and between the cells. Reason is a wrong color in the doxygen_manual.css (taken value from the standard doxygen.css). Regression on pull request #537
* | Add formula (images) to RTF outputalbert-github2018-06-051-3/+2
|/ | | | The RTF output was lacking the possibility to have formulas in it (were written as text). This patch generates the images analogous to the HTML, non MATHJAX, version and includes them in the output.
* Merge pull request #688 from albert-github/feature/bug_md_toc_docuDimitri van Heesch2018-04-221-0/+3
|\ | | | | Added note for usage of [TOC] together with Markdown headers
| * Added not for usage of [TOC] together with Markdown headersalbert-github2018-03-311-0/+3
| |
* | Merge pull request #685 from albert-github/feature/bug_single_testsDimitri van Heesch2018-04-221-0/+5
|\ \ | | | | | | Enable possibility to run single tests
| * | Enable possibility to run single testsalbert-github2018-03-271-1/+6
| |/ | | | | | | Create the possibility to run only one or more tests.