summaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* 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>`).
* | | Merge pull request #6868 from albert-github/feature/bug_secref_multicolDimitri van Heesch2019-03-091-1/+3
|\ \ \ | | | | | | | | secreflist command output shows in 1 column (HTML)
| * | | secref command output shows in 1 column (HTML)albert-github2019-03-041-1/+3
| | | | | | | | | | | | | | | | | | | | The output from the `\secref` command shows in 1 column instead of 3. The `column-count` (also possibile without `-moz` or `-webkit`) should be with the `<ul>` tag instead of the `<div>` tag
* | | | 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 #6771 from albert-github/feature/bug_cmake_versionDimitri van Heesch2019-02-171-1/+1
|\ \ | | | | | | Minimum required version for CMake
| * | Minimum required version for CMakealbert-github2019-01-151-1/+1
| |/ | | | | | | | | The `env` command with `-E` is first supported with version 3.1 setting the minimum required version as such (Based on message: https://stackoverflow.com/questions/54194646/make-docs-fails-while-building-doxygen-v1-8-15-for-rhel-distros-for-s390x and CMake documentation: https://cmake.org/cmake/help/v2.8.12/cmake.html, https://cmake.org/cmake/help/v3.0/manual/cmake.1.html and https://cmake.org/cmake/help/v3.1/manual/cmake.1.html)
* | Updated build instructions to get rid the libtinfo.so dependency on Linux ↵Dimitri van Heesch2019-02-071-1/+2
| | | | | | | | with static libclang.
* | Added instructions to build a statically linked doxygen binary from sourcesDimitri van Heesch2019-02-041-0/+20
|/
* Merge pull request #6684 from albert-github/feature/bug_broken_linksDimitri van Heesch2019-01-052-2/+2
|\ | | | | Broken links in documentation
| * Broken links in documentationalbert-github2018-12-162-2/+2
| | | | | | | | Fix broken links.
* | Incorrect XHTML of changelog for 1.8.15albert-github2018-12-291-370/+370
| | | | | | | | | | | | Checking for valid XNHTM results in: html/changelog.html:365: parser error : Excessive depth in document: 256 due to missing `</li>`
* | Fixed year in date of release 1.8.15Release_1_8_15Dimitri van Heesch2018-12-271-1/+1
| |
* | Some fixes made during packaging of the binariesDimitri van Heesch2018-12-271-1/+1
| |
* | Changelog for release 1.8.15Dimitri van Heesch2018-12-261-0/+401
| |
* | 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.
* | | Corrected description of XML output for emoji charactersDimitri van Heesch2018-12-241-1/+1
| | |
* | | Merge pull request #6685 from albert-github/feature/bug_changelogDimitri van Heesch2018-12-241-1101/+7160
|\ \ \ | | | | | | | | Update of changelog
| * | | Update of changelogalbert-github2018-12-161-1101/+7160
| | |/ | |/| | | | | | | | | | - integrating older versions of the changelog (i.e. version 1.5 and older, so no external references to doxygen changelog pages) - correcting permanent redirects
* | | Improved robustness of the emoji featureDimitri van Heesch2018-12-236-124/+90
| | | | | | | | | | | | | | | | | | | | | | | | 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).
* | Merge pull request #6679 from coliff/masterDimitri van Heesch2018-12-149-0/+0
|\ \ | | | | | | Losslessly optimize images
| * | [ImgBot] Optimize imagesImgBotApp2018-12-079-0/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | *Total -- 536.41kb -> 410.38kb (23.5%) /doc/extsearch_flow.png -- 20.57kb -> 7.41kb (64%) /testing/sample.png -- 3.69kb -> 2.50kb (32.26%) /doc/doxywizard_main.png -- 55.86kb -> 38.51kb (31.07%) /doc/doxywizard_page1.png -- 38.72kb -> 29.24kb (24.47%) /doc/doxywizard_page4.png -- 42.69kb -> 32.57kb (23.72%) /doc/doxywizard_page3.png -- 49.71kb -> 37.95kb (23.66%) /doc/doxywizard_page2.png -- 38.13kb -> 29.21kb (23.41%) /addon/doxywizard/images/tunecolor.png -- 99.90kb -> 77.30kb (22.62%) /doc/doxywizard_menu.png -- 57.29kb -> 45.09kb (21.28%) /doc/doxywizard_expert.png -- 29.35kb -> 23.73kb (19.15%) /templates/html/mag_sel.png -- 0.55kb -> 0.45kb (17.41%) /templates/html/mag.png -- 0.51kb -> 0.44kb (14.31%) /doc/infoflow.png -- 98.24kb -> 84.89kb (13.59%) /templates/html/search_r.png -- 0.60kb -> 0.54kb (9.64%) /templates/html/search_l.png -- 0.59kb -> 0.55kb (6.13%)
* | | Update parsing extension table in documentationalbert-github2018-12-101-32/+26
| | | | | | | | | | | | | | | The text underneath the table in the documentation regarding the use of extensions was not correct. Also added the C / C++ category and made the table a bit better readable.
* | | Doxygen manual is not XHTML compliantalbert-github2018-12-056-333/+328
|/ / | | | | | | | | | | | | | | | | 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 pull request #6621 from albert-github/feature/bug_docu_chapter_namesDimitri van Heesch2018-11-202-12/+12
|\ \ | | | | | | Synchronize chapter names of doxygen's own documentation.
| * | Synchronize chapter names of doxygen's own documentation.albert-github2018-11-172-12/+12
| | | | | | | | | | | | | | | Synchronize names of chapters of doxygen's own documentation between HTML output and LaTeX output. Corrected a small error regarding wrong tag in documentation ('<--' -> '<!--')
* | | Correct list of not used translator functionsalbert-github2018-11-202-8/+18
|/ / | | | | | | | | | | All translator function functions were mentioned as not used. - the directory to find the places where the sources are that use translator functions was pointing to the src directory of the build tree instead the src directory in the source tree (source files are not copied) and thus finding no applicable sources. - furthermore the test whether or not a function was based on the name of a function but in case a name is the short form of an other function and the longer name was not used it was still shown as used.
* | 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-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).
generated by cgit v0.12 at 2024-11-18 02:03:59 (GMT)