summaryrefslogtreecommitdiffstats
path: root/src/config.xml
Commit message (Collapse)AuthorAgeFilesLines
* Added configuration options to better control the sqlite3 output.Dimitri van Heesch2020-07-301-5/+12
| | | | | | | | | | | | Still requires cmake -Duse_sqlite=YES to compile in support (and libsqlite3) New configuration options available: - GENERATE_SQLITE3 enable/disable SQLITE3 output - SQLITE3_OUTPUT configure directory where output is written to (default: sqlite3) - SQLITE3_RECREATE_DB controls if existing database file is overwritten (default: YES)
* Prefer more inclusive languageGlenn Kasten2020-07-291-1/+1
| | | | | | | Doxygen is used for some Android API documentation, hence: Update language to comply with Android’s inclusive language guidance. See https://source.android.com/setup/contribute/respectful-code for reference
* Merge pull request #7869 from albert-github/feature/issue_7865Dimitri van Heesch2020-07-281-2/+5
|\ | | | | issue #7865 Update documentation of USE_PDFLATEX option
| * issue #7865 Update documentation of USE_PDFLATEX optionalbert-github2020-06-231-2/+5
| | | | | | | | Updated texts to better reflect current situation
* | issue #7921: Help for CLANG_DATABASE_PATH is misleadingDimitri van Heesch2020-07-251-4/+6
| |
* | Correct misspelling in config.xmlMichael Quevillon2020-06-241-1/+1
|/
* Incorrect text for HTML_FORMULA_FORMAT in documentation / Doxyfile (#7722)albert-github2020-04-251-2/+2
| | | | | | | | | For the configuration setting `HTML_FORMULA_FORMAT` the text reads: > Possible values are: png The default and svg Looks nicer but requires the pdf2svg tool. this is not quite understandable and has been reformulated to: > Possible values are: png (the default) and svg (looks nicer but requires the pdf2svg or inkscape tool). this concerns automatically generated texts from config.xml to the different formats.
* Changed content delivery default URL for MATHJAX_RELPATH option to jsdelivr.netDimitri van Heesch2020-04-111-1/+1
|
* Remove support for TCL (code is too buggy and unmaintained, language not ↵Dimitri van Heesch2020-03-151-13/+3
| | | | very popular)
* Merge pull request #7596 from albert-github/feature/bug_form_svgDimitri van Heesch2020-02-171-1/+2
|\ | | | | Creation of svg images for formulas with inkscape
| * Creation of svg images for formulas with inkscapealbert-github2020-02-151-1/+2
| | | | | | | | | | | | | | Based on the implementation as mentioned in #7578 to add the possibilities to generated svg images for formulas - When running with inkscape 92.3 / 92.4 on Cygwin /Windows there were no images generated as the `-o` flag didn't exist, the output file had to be specified as part of the `-l` (or `--export-plain-svg`) option - For more flexibility the system is checked on existence of the `pdf2svg` and `inkscape` executables, so no compilations flags are necessary
* | issue #7590 Map .f18 filetype to Fortranalbert-github2020-02-141-0/+1
|/ | | | Supporting f18 extension
* Forgot to remove some config files.Dimitri van Heesch2020-02-131-4/+4
| | | | Added development option to use inkscape to create SVG formulas.
* Improve formula handling and rendering.Dimitri van Heesch2020-02-121-0/+11
| | | | Also added option HTML_FORMULA_FORMAT to generate SVG files for images (requires pdf2svg)
* Merge pull request #7230 from albert-github/feature/bug_formula_macrofileDimitri van Heesch2019-12-251-0/+10
|\ | | | | Create possibility to define LaTeX commands for formulas
| * Create possibility to define LaTeX commands for formulasalbert-github2019-08-271-0/+10
| | | | | | | | | | | | To be able to have building bocks for formulas one can create a `\newcommand` (or when one wants to change a command `\renewcommand`). Due to the different handling of LaTeX commands in pure LaTeX code (latex output and formulas converted to images) and MathJax it is necessary to transform LaTeX commands to the MathJax equivalent. This is done in a transparent way by providing the new commands in a file and add this verbatim to the pure LaTeX code and to translate the `\newcommand` and `\renewcomamnd` to MathJax macros.
* | Merge branch 'master' into spellingDimitri van Heesch2019-12-231-2/+2
|\ \
| * | issue 3417: C++: friend template functions shown even with ↵Dimitri van Heesch2019-12-211-1/+1
| | | | | | | | | | | | HIDE_FRIEND_COMPOUNDS=yes
| * | Renamed Portables to PortableDimitri van Heesch2019-12-081-1/+1
| | |
| * | Refactoring of portable.h and portable.cpp functions to be contained in a ↵Tobias Off2019-11-281-1/+1
| | | | | | | | | | | | | | | | | | namespace Fixing some memory issues caused by not correctly freed pointers
* | | spelling: javascriptJosh Soref2019-11-121-5/+5
|/ /
* | issue #7218 Doxygen parsing word documentsalbert-github2019-08-231-1/+3
|/ | | | | making list consistent again. See also table in chapter "Getting Started"
* Fixing redirection linksalbert-github2019-08-081-5/+5
| | | | | 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)
* warning: Reached end of file while still inside a (nested) comment.albert-github2019-08-021-1/+1
| | | | see to it that the JAVA_BANNER comment is not seen as new start of comment, but is shown as verbatim comment (works for doxygen documentation, Doxyfile and doxywizard).
* Made MSCGEN_PATH obsolete now that mscgen code is part of doxygenDimitri van Heesch2019-06-241-11/+1
|
* Cygwin should by default also have `CASE_SENS_NAMES=NO`albert-github2019-06-151-2/+2
| | | | | Cygwin should by default also have `CASE_SENS_NAMES=NO` like is the case for the underlying Windows. In case of Cygwin the define `_WIN32` is not set so we also have to test for `__CYGWIN__`
* Merge pull request #6957 from ↵Dimitri van Heesch2019-05-211-0/+11
|\ | | | | | | | | cfriedt/feature/cfriedt/6955/allow-javadoc-style-comment-blocks-with-a-doxyfile-variable Allow Javadoc-style comment blocks with a Doxyfile variable
| * Allow Javadoc-style comment blocks with a Doxyfile variableChristopher Friedt2019-05-031-0/+11
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Javadoc allows comments like this (which I refer to as "banner" comments) /***************** * *****************/ but doxygen does not recognize them. Instead, the doxygen manual says to do this /*************//** * ****************/ which some users aren't even aware is required. It also behaves poorly with clang-format. I'm proposing to add a Doxyfile boolean option JAVADOC_BANNER which will default to NO. When set to YES, it will consider the first and second comments above to be equivalent. However, I don't believe that the JAVADOC_BANNER option should default to YES, as there are likely a number of projects who have used the former syntax with full expectation that it would *not* appear in their documentation. At least having the JAVADOC_BANNER default to NO allows users to opt-in voluntarily by adding JAVADOC_BANNER = YES to their Doxyfile. If the consensus is to make it a default at a later time, first a warning can be added during build that should trigger users to modify their comment style, and then eventually the default could be set to JAVADOC_BANNER = YES, or the config option could be removed entirely and it would just always be enabled.
* | Bug 783759 - PERL_PATH config option: when is this needed? Still used?albert-github2019-05-071-10/+1
|/ | | | 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.
* issue #6791 TOC not generated when using a particular Markdown header stylealbert-github2019-01-211-1/+1
| | | | | The default for the `TOC_INCLUDE_HEADERINGS` was set to 0, for compatibility this should be 5. (Problem was observed in the doxygen documentation, chapter markdown, where the TOC was missing; alternatively in the Doxyfile the `TOC_INCLUDE_HEADERINGS` could be set to `5`,. The solution chosen is more consistent with the old situation).
* Shortened EXTRACT_PRIVATE_VIRTUAL to EXTRACT_PRIV_VIRTUAL to deal with max ↵Dimitri van Heesch2019-01-081-2/+2
| | | | length limitation
* Merge branch 'extract-private-virtual' of https://github.com/mosra/doxygen ↵Dimitri van Heesch2019-01-081-0/+8
|\ | | | | | | into mosra-extract-private-virtual
| * Implement a new EXTRACT_PRIVATE_VIRTUAL option.Vladimír Vondruš2019-01-031-0/+8
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The classic article about virtuality from Herb Sutter [1] suggests that virtual functions are always private and public class interface is never virtual. Until now, it was not really possible to document these functions in Doxygen: * Enabling EXTRACT_PRIVATE would show all internals, not just virtual functions, which is not wanted. * Enabling HIDE_UNDOC_MEMBERS and HIDE_UNDOC_CLASSES would effectively disable warnings about *all* undocumented members, which is not wanted. The usual workaround was to put the members into protected scope just for Doxygen: #ifdef DOXYGEN_GENERATING_OUTPUT protected: #else private: #endif /** @brief Documented private virtual function */ virtual doStuff(); The new EXTRACT_PRIVATE_VIRTUAL option makes these visible (and able to be linked to), but shows them *only* if they are documented. [1] http://www.gotw.ca/publications/mill18.htm
* | issue #6725 Doxygen 1.8.15 CMake 3.13 incompatibilityalbert-github2019-01-071-2/+3
|/ | | | Fix to overcome problems in CMake. The required `\` in the `tex` code is automatically added when generating the LaTeX files.
* Fix type and length of clang compilation database optionDimitri van Heesch2018-12-271-1/+1
|
* Renamed option and test case numbersDimitri van Heesch2018-12-261-2/+2
|
* Merge branch 'xml-namespace-members-in-file-scope' of ↵Dimitri van Heesch2018-12-261-0/+9
|\ | | | | | | https://github.com/mosra/doxygen into mosra-xml-namespace-members-in-file-scope
| * Make it possible to list namespace members in file scope for XML output.Vladimír Vondruš2018-02-101-0/+9
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | For better consistency with the HTML output, where each file documentation lists (and links to) all members of given namespace. This also makes it possible to be consistent with the HTML output in case a namespace is not documented and thus all its member detailed docs should be put into corresponding file docs instead. In order to be backwards compatible and avoid breaking stuff for existing users of the XML output, this is controlled by a new XML_NAMESPACE_MEMBERS_IN_FILE_SCOPE configuration option that defaults to NO. Note that this, unlike the HTML output, will put the whole detailed docs into the file scope instead of just listing them. It's up to the user of the XML output to deduplicate this information. It can be done for example by comparing member ID prefixes with compound ID -- íf different, the detailed docs are already somewhere else.
* | Merge branch 'master' of https://github.com/zeroc-ice/doxygen into ↵Dimitri van Heesch2018-11-171-540/+551
|\ \ | | | | | | | | | zeroc-ice-master
| * \ Merge remote-tracking branch 'doxygen/master'Joe George2018-11-021-11/+11
| |\ \
| * | | Added *.ice files as a recognized file type.Mark Spruiell2018-10-221-540/+551
| | | | | | | | | | | | | | | | Added a Slice-optimized output mode.
* | | | Merge branch 'feature/issue_6517' of ↵Dimitri van Heesch2018-11-111-0/+10
|\ \ \ \ | |_|/ / |/| | | | | | | https://github.com/albert-github/doxygen into albert-github-feature/issue_6517
| * | | issue_6517: Emoji supportalbert-github2018-10-011-0/+10
| |/ / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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
* | | Documentation internet addressesalbert-github2018-10-271-11/+11
|/ / | | | | | | Running a link checker revealed a number of not existing / redirected addresses, these have been corrected.
* | Usage of '{', '}' and ',' in ALIASalbert-github2018-09-141-0/+24
| | | | | | | | | | | | | | | | | | | | | | | | | | 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 mail addressDimitri van Heesch2018-09-011-1/+1
| |
* | Merge pull request #6397 from albert-github/feature/bug_docu_extension_mappingDimitri van Heesch2018-07-301-3/+3
|\ \ | | | | | | Documentation EXTENSION_MAPPING
| * | Documentation EXTENSION_MAPPINGalbert-github2018-07-151-3/+3
| | | | | | | | | | | | Small addition of some missing "languages" in respect to EXTENSION_MAPPING.
* | | Merge branch 'feature/bug_latex_index' of ↵Dimitri van Heesch2018-07-231-0/+14
|\ \ \ | | | | | | | | | | | | https://github.com/albert-github/doxygen into albert-github-feature/bug_latex_index
| * | | Making the 'tex' part of \makeindex available to the useralbert-github2018-05-081-0/+14
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | In case we need to use another 'makeindex' command in the Makefile / make.bat we can use the configuration tag MAKEINDEX_CMD_NAME When we want to have another index we can use e.g. EXTRA_PACKAGES = [nottoc]tocbibind but in those cases the \makeindex command is still the same but should be \makeindex[intoc]. By means of the new configuration tag LATEX_MAKEINDEX_CMD this discrepancy has been solved. Due to the default value some small changes in the configuration parser were necessary as well. (based on the stack question https://stackoverflow.com/questions/44394311/add-index-to-toc-with-doxygen).
generated by cgit v0.12 at 2024-07-08 03:05:13 (GMT)