| Commit message (Collapse) | Author | Age | Files | Lines |
... | |
|
|
|
| |
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).
|
| |
|
|
|
|
|
| |
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__`
|
|\
| |
| |
| |
| | |
cfriedt/feature/cfriedt/6955/allow-javadoc-style-comment-blocks-with-a-doxyfile-variable
Allow Javadoc-style comment blocks with a Doxyfile variable
|
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| | |
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.
|
|/
|
|
| |
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.
|
|
|
|
|
| |
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).
|
|
|
|
| |
length limitation
|
|\
| |
| |
| | |
into mosra-extract-private-virtual
|
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| | |
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
|
|/
|
|
| |
Fix to overcome problems in CMake. The required `\` in the `tex` code is automatically added when generating the LaTeX files.
|
| |
|
| |
|
|\
| |
| |
| | |
https://github.com/mosra/doxygen into mosra-xml-namespace-members-in-file-scope
|
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| | |
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.
|
|\ \
| | |
| | |
| | | |
zeroc-ice-master
|
| |\ \ |
|
| | | |
| | | |
| | | |
| | | | |
Added a Slice-optimized output mode.
|
|\ \ \ \
| |_|/ /
|/| | |
| | | | |
https://github.com/albert-github/doxygen into albert-github-feature/issue_6517
|
| |/ /
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | | |
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
|
|/ /
| |
| |
| | |
Running a link checker revealed a number of not existing / redirected addresses, these have been corrected.
|
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| | |
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.
|
| | |
|
|\ \
| | |
| | | |
Documentation EXTENSION_MAPPING
|
| | |
| | |
| | |
| | | |
Small addition of some missing "languages" in respect to EXTENSION_MAPPING.
|
|\ \ \
| | | |
| | | |
| | | | |
https://github.com/albert-github/doxygen into albert-github-feature/bug_latex_index
|
| | | |
| | | |
| | | |
| | | |
| | | |
| | | |
| | | |
| | | |
| | | | |
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).
|
|\ \ \ \
| |_|/ /
|/| | | |
Correction in example of FILE_VERSION_FILTER
|
| |/ /
| | |
| | |
| | | |
Corrected name in example and corrected layout in documentation.
|
|\ \ \
| | | |
| | | | |
Bug 678684 - Not warning of undocumented function parameters
|
| |/ /
| | |
| | |
| | | |
Noted in documentation that parameter has no effect in case of EXRTACT_ALL
|
| | |
| | |
| | |
| | | |
Corrected reference to use of CLANG option in Doxyfile.
|
|\ \ \
| |/ / |
|
| |/ |
|
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| | |
1) Build error:
Unexpected token 'semic' on the line 50 in '/home/travis/build/doxygen/doxygen/build/src/translator.h'.
status = 2 in collectPureVirtualPrototypes()
Due to a discrepancy what translator.py expects and is in the actual code.
In the actual code a (not required) ; was present after the closing } of the routine.
2) Unknown command \cpdflatex
|
|/
|
|
| |
For a number of languages the output in LaTeX has been improved so the regular documentation can be generated (automatically) in LaTeX / PDF as well.
|
|
|
|
| |
Based on stack overflow question "Track C variable doxygen" (https://stackoverflow.com/questions/48586670/track-c-variable-doxygen)
|
|\ |
|
| |
| |
| |
| | |
HTML output
|
|\ \
| | |
| | | |
Physical newlines in ALIASES configuration tags.
|
| | |
| | |
| | |
| | |
| | |
| | | |
Some commands read input till the end of the physical line. In case these commands are used in an alias the rest of the line is lost / gives not the required results.
This patch creates the possibility to have physical newlines in ALIASES.
See also: https://stackoverflow.com/questions/46050789/doxygen-alias-with-multiple-commands
|
| | |
| | |
| | |
| | |
| | | |
Super trivial typos
Some are in qtools/ which I know is a 3rd party dependency but as we know is now obsolete upstream. I reckon it wouldn't be much of an issue to merge neverthless
Tacked on several more commits
|
|/ /
| |
| |
| |
| |
| |
| | |
Set the default MATHJAX_RELPATH to the current recommended value:
https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/
(See https://www.mathjax.org/cdn-shutting-down/ )
|
|\ \
| |/
|/| |
|
| | |
|
| |
| |
| |
| | |
See: https://clang.llvm.org/docs/JSONCompilationDatabase.html
|
| |
| |
| |
| |
| | |
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
|
|/ |
|
|
|
|
|
|
| |
some doxy typos and some misc. source typos
typos
some doxy typos and some misc. source typos
|
| |
|