./devel/doxygen, Documentation system for C++, Java, IDL and C

[ CVSweb ] [ Homepage ] [ RSS ] [ Required by ] [ Add to tracker ]

Branch: CURRENT, Version: 1.9.7nb1, Package name: doxygen-1.9.7nb1, Maintainer: pkgsrc-users

Doxygen is a documentation system for C++, Java, IDL (Corba, Microsoft and
KDE-DCOP flavors) and C.

It can help you in three ways:

1. It can generate an on-line documentation browser (in HTML) and/or an
off-line reference manual (in LaTeX) from a set of documented source
files. There is also support for generating output in RTF (MS-Word),
PostScript, hyperlinked PDF, compressed HTML, and Unix man pages. The
documentation is extracted directly from the sources, which makes it
much easier to keep the documentation consistent with the source code.

2. Doxygen can be configured to extract the code structure from
undocumented source files. This can be very useful to quickly find your
way in large source distributions. The relations between the various
elements are be visualized by means of include dependency graphs,
inheritance diagrams, and collaboration diagrams, which are all
generated automatically.

3. You can even `abuse' doxygen for creating normal documentation

Required to run:
[print/ghostscript] [graphics/graphviz] [lang/perl5] [lang/python37]

Required to build:
[textproc/py-expat] [pkgtools/cwrappers]

Master sites:

Filesize: 5601.998 KB

Version history: (Expand)

CVS history: (Expand)

   2023-05-22 23:00:50 by Thomas Klausner | Files touched by this commit (645)
Log message:
*: bump for libproxy 0.5
   2023-05-19 12:37:20 by Adam Ciarcinski | Files touched by this commit (5) | Package updated
Log message:
doxygen: updated to 1.9.7

Release 1.9.7

Bug fixes

bug 327697 Ignores single-line /*! ... */ comment contents sometimes
bug 473140 Broken anonymous union data in XML
bug 548438 VERBATIM_HEADERS - only works with header files with file type
bug 564252 HTML output for pure virtual function with "throws()" hint \ 
is wrong
bug 594746 [html] wrong <title> value, missing title in page for \ 
"Members" pages
bug 628022 single `-` in `<pre>` busts nesting levels
bug 636706 Support regular expressions in EXCLUDE_SYMBOLS
bug 752410 make.bat on UNC paths will start to erase files from c:\windows\system32
bug_665439 FILE_VERSION_FILTER incorrectly run for file references from a \ 
tagfile with filename "<tagfile>:/my/path"
bug_676971 HIDE_SCOPE_NAMES also hides template declarations of template member \ 
functions in detail description
issue 6737 end of comment inside code block
issue 7087 Invalid (X)HTML in case of \mscfile, \dotfile, \diafile,
issue 7386 Method parameters documented inline are not present in documentation \ 
when using @copydoc
issue 8790 doxyrest command returns "duplicate member id group...",,
issue 9159 Doxygen produces ugly empty space in LaTeX and PDF output because of \ 
issue 9254 Markdown page subpage and treeview
issue 9319 Doc build fails with cairo 1.17.6,
issue 9368 subsubsection and beyond text rendered inline on LaTeX
issue 9668 Doxygen confused with enum class in nested namespaces
issue 9696 bug 466064 Formatting-options for $datetime
issue 9713 Variables show in "Related Functions" section
issue 9718 class diagram's width is not correct and class member appears weird,,
issue 9719 \ref command does not insert title of referenced page,,
issue 9726 \ref command doesn't perform in LaTeX as described in the documentation
issue 9756 Doxygen produces invalid output for many C interpolated strings
issue 9763 Python docstring: brief and detailed description not correctly \ 
separated by blank line
issue 9771 Escaped double-quote in Objective-C string confuses parser
issue 9779 Doxygen doesn't correctly treat nested \if statements
issue 9783 Some functions are not listed in "referenced by"
issue 9810 Math in bibliography
issue 9816 Missing search files in QCH content,
issue 9831 @exception description paragraph does not accept @ref tag,
issue 9839 Server side search is returning wrong results
issue 9845 C parser reads "$" as "Interpolated string \ 
expression" which is not correct
issue 9846 Python functions with and without type hints displayed inconsistently.
issue 9850 Link to class enum in namespace not working in file reference
issue 9852 Operator<< not parsed correctly in template class
issue 9855 HTML: TOC: Smooth scrolling
issue 9858 Markdown: Heading auto id starting with digit of minus sign
issue 9861 Links among markdown files don't work if upstream path element \ 
contains space
issue 9883 Performance issues when HAVE_DOT is YES to make \dot work, and \ 
CLASS_GRAPH=GRAPH is also used
issue 9885 References to enum member partially broken since v1.9.5
issue 9911 Support < for documenting members and variables
issue 9921 HIDE_SCOPE_NAMES does not hide names in treeview
issue 9932 Incomplete Style.css
issue 9935 Doxygen WARN_LOGFILE needs to create folder
issue 9942 warning: Member try (variable) of namespace lib_validation is not \ 
issue 9947 Attributes resulting of an unpacked tuple are not documented (Python),,,
issue 9950 PlantUML is not fully supported in markdown fenced code blocks
issue 9963 [VHDL] - Generic parameter list of generic subprograms are not printed
issue 9963
issue 10006 Problem with generated documentation when a method is named 'exception'
issue 10010 SHOW_HEADERFILE doesn't work well for headers with no file extension
issue 10013 infinite recursion (stack overflow) in findScopeFromQualifiedName
issue 10015 Add warning when file set for USE_MDFILE_AS_MAINPAGE isn't found
issue 10050 Typo in the Doxygen \todo documentation
avoid csp insecure eval on search box.
fix sqlite3gen regressions from 592aaa4
Fix server based search for PHP 8.1
search: Fix incorrect result count in opensearch suggestions
Don't show `__pad*__` for unnamed bitfields
Check and copy logo file for rtf output
Escape `-` sign in fontname settings substring as well,
Latex incorrect handling of backticks in code fragments
Variables were shown with () in the client side search results
Prevent bogus type assignment in Python output
Rename correct file to .bak when using "doxygen -u <some-path>" \ 
(issue 10035)
Double identifiers due to mapping to same id of file names,
Fixed cross referencing issue.
Limit index fields in hhk file of chm file.
Hide undocumented group members when `HIDE_UNDOC_MEMBERS=YES`
Handling of `\noop` command in preprocessor
Handling of verbatim type sections in preprocessor,
Fixes for type bound procedures in Fortran
Incorrect warning about not matching number of `if` / `endif`
Text on start line of fenced code block should not be ignored.,
Undefined references in pdf documents
No anchor should be created for inherited members,
Not documented parameter in case of `const <type>` without argument name
Prevent list items in section titles,


New option MSCGEN_TOOL for running mscgen externally,
New option MARKDOWN_ID_STYLE to generate GitHub style identifiers for sections
New option SITEMAP_URL to generate Sitemaps
New option TIMESTAMP to disable pages without timestamps (replaces \ 
Making settings from settings file available via new \doxyconfig command.,
Add '<thead>', '<tbody>' and '<tfoot>' HTML tags as dummies
Add `point` as email separator
Improved group handling for defines, static functions, and enums,, and
Support visible attribute for all elements in the layout file,,,
Ignore C11 _Static_assert()
Adding "engine" ebnf, hcl, and regex for plantuml,
Better handling of punctuation characters in GitHub anchors
Better representation of brief (union / struct) descriptions in HTML
Better warning from constant expression evaluation
Reduce LaTeX warnings,,
Support for basic hierarchical grouping in LaTeX output
Support hierarchical groups in RTF and use the same model for pages
Improve default LaTeX hypertarget location
Allow multiple newlines in a Markdown code span.,
Enable possible other LaTeX error modes via new LATEX_BATCHMODE options,
Added option `trimleft` to the command `\snippet`

Improved user feedback and documentation

bug 630661 Highlighting lines in a dot graph,
bug 615500 Program Icon under Windows,
doc(commands): Update \class example link
doc(commands): Update example links for manual.c
doc(diagrams): Better HTML example link
doc(grouping): Link memgrp example to file docs
doc(various): Match HTML and LaTeX example links
docs(docblocks): Update some example hyperlinks
Translation of terms in tooltip
Updated Portuguese, Spanish, and Swedish translators,,,,
Improve readability/contrast of "use" arrows in dark mode
Hyperlinks in help information of doxywizard
Fix for some permanent redirects
Coloring in languages table in manual
Collect warnings and output them at the end
Debugging documentation
Incorrect HTML generated for doxygen manual,
Incorrect and redirect links in documentation
Incomplete dependency translation report
Spelling corrections,,,,,,,
Confusing edge tooltips shown
Applied various cosmetic changes to the HTML output
Confusing entries in legend explanation
Consistency in HTML output with multiple runs
Consistency / links in LaTeX output of the doxygen documentation
Consistency between HTML and LaTeX / RTF for examples
Consistency between return type and usage of pid
Consistency in used debug terminology
Correct wording of fatal error message
Documentation `\ianchor` correction
Preserve whitespace after \showdate format
Silently ignore `</img>` tag
Union / Struct indicated as Class in the Xref list,
Labels were not visible in dark mode for some dot graphs,
Fixed problem with the client side search engine (HTML output)
Improve layout of table with HTML commands on documentation
Improvement of position of open / closed folder icon
The CDATA sections in xml code representation should not be interpreted

Refactoring and cleanup

Reduce code duplication,,,
Reduce lock contention in symbol resolver
Refactor (sub)page handling for LaTeX
Refactoring: Improve performance of computeMemberRelations()
Refactoring: Optimize Definition::name() and Definition::localName()
Refactoring: Remove raw pointer use from cmdmapper
Refactoring: Store DocNodeVariant pointer inside DocNodes
Refactoring: Use std::variant for code generators
Refactoring: add OutputCodeList to specific generators
Refactoring: add multi-thread support to generateJSNavTree()
Refactoring: add multi-thread support to writeJavaScriptSearchIndex()
Refactoring: avoid unneeded DocParser pushContext/popContext calls
Refactoring: better use of smart pointers for layout module
Refactoring: embed TokenInfo in doctokenizer as value instead of pointer
Refactoring: for ScopedTypeVariant use std::variant
Refactoring: improve argv/argc handling for libclang API
Refactoring: improve performance of selectBlock()
Refactoring: let create*Def() functions return std::unique_ptr instead of raw pointer
Refactoring: make a couple of global enums scoped
Refactoring: make use of C++17 structured bindings
Refactoring: move detab() to util.cpp so it can be shared
Refactoring: move some functionality from generic to more specific files
Refactoring: optimize addHtmlExtensionIfMissing()
Refactoring: optimize keyword substitution for LaTeX output
Refactoring: optimize toLowerChar()
Refactoring: pass variant by moving instead of copying
Refactoring: remove BaseOutputDocInterface class
Refactoring: remove CodeOutputInterface base class from OutputCodeList
Refactoring: remove toClassDefMutable for const input
Refactoring: remove toMemberDefMutable for const input
Refactoring: remove toNamespaceDefMutable for const input
Refactoring: remove unneeded m_impl indirection from MemberDefImpl
Refactoring: remove unused code
Refactoring: remove unused conversion function
Refactoring: replace types uchar/uint/ulong/int64/uint64 by stdint types
Refactoring: simplified the way search data from source code is gathered
Refactoring: simplify ConfigImpl's instance handling
Refactoring: use OutputCodeList for parsing code instead of CodeOutputInterface
Refactoring: use smart pointers for Definition class internals
Refactoring: use smartpointer for Doxygen::searchIndex instance
Refactoring: use std::unique_ptr for FileState in pre.l
Refactoring: use std::variant for generators instead of polymorphism
Refactoring: make MemberVector hold non-const MemberDef pointers
Optimize findFileDef locking
Build: Re-enable LEX_FILES_{H,CPP}, streamline
Various refactorings
Make configuration default texts configurable
Make language detection for fenced code blocks more robust
Make reading configuration utf-8 compatible
Removed unneeded mutable keyword and added missing lock
Improve debugging for lexical scanners
Replace custom tracing/debug prints by tracing via spdlog

Improved testing

Add test case for define doc association
Add test case for direct define documentation
Add test case for enum doc association
Add test case for enum field doc association
Add test case for file doc association
Add test case for function doc association
Add test case for static assertions
Add test case for typedef doc association
Add test case for variable doc association
Add test for doc entry association with groups
testing: Add test case for enum fields
ci: create workflow to publish Docker image
runtests.py: Support tests with addtional inputs
Added unit test with unicode characters in the name
Adding some attributes to dtd validation
   2023-04-19 10:12:01 by Adam Ciarcinski | Files touched by this commit (2359) | Package updated
Log message:
revbump after textproc/icu update
   2023-04-03 22:21:34 by Niclas Rosenvik | Files touched by this commit (436)
Log message:
Revbump due to dependecy change in qt5-qtbase
Since these dependecies are bundled with
qt5-qtbase and not exposed to qt5 using
applications directly, only bump direct users
of qt5-qtbase.
   2023-01-29 22:18:34 by Ryo ONODERA | Files touched by this commit (2527)
Log message:
*: Recursive revbup from graphics/freetype2
   2023-01-24 19:36:36 by Thomas Klausner | Files touched by this commit (103)
Log message:
*: convert to cmake/build.mk
   2022-12-31 22:21:55 by Adam Ciarcinski | Files touched by this commit (2) | Package updated
Log message:
doxygen: updated to 1.9.6

Release 1.9.6

Bug fixes

issue 1166: Read error when multi-byte characters in file path name (Origin: \ 
bugzilla 145186)
issue 3244: IGNORE_PREFIX works also on names of functions/methods
issue 3798: \relates does not find class if it is in an anonymous namespace
issue 5621: First % in markdown inline code segement a la %PATH% is swallowed, \ 
bug 736665
issue 9221: Tag File - option to Strip path
issue 9317: File-scoped nested namespaces in C
issue 9319: Doc build fails with cairo 1.17.6
issue 9552: False warning "@param documentation sections but no \ 
arguments" on using declarations/typedefs
issue 9566: Same member groups in multibyte characters are separately generated.
issue 9582: `noexcept(false)`-function is labeled as noexcept
issue 9584: Warning "Illegal command \ifile found as part of a \c \ 
command" in \copydoc, but not original documentation
issue 9587: Autolinks to functions do not take effect
issue 9602: Link to namespace in TAGFILES is not resolved with EXTRACT_ALL=NO
issue 9604: PlantUML @start<engine> not recognized
issue 9605: fix for unknown entities in the preprocessor conditionals
issue 9616: Regression in 1.9.4 in HTML Tree View (command \mainpage)
issue 9617: visible="no" ignored in treeview
issue 9622: C++ concepts are not linked to namespaces in XML output
issue 9650: Private methods marked only as override are not documented when \ 
issue 9669: Namespaces in arguments of a method breaks cref resolving in C
issue 9672: doxygen does not interpret Python docstrings when typed next to \ 
SLURM directives
issue 9678: Unable to resolve reference to template class or its member inside a \ 
issue 9682: Missing HTML pages and broken links for undocumented C++ concepts
issue 9697: Minor correction to documentation
issue 9715: segmentation fault (recursive classes?)
issue 9720: Recursive class relation warning when using type aliases starting \ 
with 57f5ad2
issue 9721: \code blocks have blank lines removed in LaTeX/PDF output
issue 9722: Doxygen Regression when documenting enums for C(1.94 -> 1.9.5)
issue 9733: doxygen stops parsing a file if one uses latex formulas and //!< \ 
or ///< for inline parameter documentation
issue 9736: Doxygen will not generate class information for a C class that \ 
contains certain string combinations
Apply scrollbar styling when rendering the internal docs with WebKit
Fix a number of threading issues when NUM_PROC_THREADS!=1
Fixed a couple of threading issues when NUM_PROC_THREADS!=1
Bugfix of malformed UML class diagram generated thru graphviz.
Bugfix of malformed VHDL process flowchart generated thru graphviz.
Area tag does not give `alt=""` as of dot 7.0.2
Incorrect interactive svg file for dot
Correcting default HTML stylesheets for color style LIGHT and DARK
Fixed some issues handling character literals in template arguments
Removing hierarchy / namespace from layout file results in incorrect RTF / LaTeX \ 
Unknown entities in the preprocessor conditionals
Hash comment in php
Incorrect man code output in respect to backslashes
Spurious characters in Fortran Fixed to free format conversion
Incorrect handling of escaped ilinebr command
Incorrect return of getUTF8CharAt giving wrong alphabetical index
Reference to non existing pages with embedded anonymous union / struct


Adding Python PEP 526 typing support
issue 2580: Formatting-options for $datetime
issue 9702: Add new command \qualifier to add custom tags that would be similar \ 
to "inline" and "static" to some functions or classes
issue 9549: Feature request: Allow to disable Webkit scrollbar styling
NUM_PROC_THREAD!=1 will now process formulas on multiple threads
Treat __name variable as private and _name variables as protected in Python
Add support for multiple <summary> sections inside <details>
Added option WARN_IF_UNDOC_ENUM_VAL to have warnings for undocumented enum values

Improved user feedback and documentation

Documentation correction in config.xml
HTML_COLORSTYLE improve documentation
Layout, textual, syntactical changes documentation
Correction and making more uniform texts for the different lists
Fix unreadable file warnings for broken symlinks with EXCLUDE_SYMLINKS is set
Doxywizard: Don't show default text in case no default value present,
Show "Additional Inherited Members" for LaTeX, RTF, etc.
Fixed main menu and submenu items for Fortran and VHDL in context of other languages.
Incorrect documentation for the command `\fileinfo`
QHP output requires that HTML output is generated
Dutch and czech localization update to "new since 1.9.6.
Portuguese translators updated to 1.9.6
Update translator_fr.h
Added translation specialization for VHDL in the \ 
`trMemberFunctionDocumentation()` method.

Refactoring and cleanup

Refactoring: Improve constness of commentcnv interface and added comments
Refactoring: Minor cleanup of the constant expression parser
Refactoring: Move global index counters into a Index singleton class
Refactoring: Move javascript license file to header
Refactoring: Use Compile Time Regular Expressions instead of reg::Ex
Refactoring: better split output generator and code generator
Refactoring: cleanup index interface and implementation
Refactoring: some minor performance tweaks
Usage of steady_clock
Check debug settings by means of the compiler
Incorrect place of prototype of `dateToString`
Optimize fragment inclusion performance for INLINE_SOURCES=YES
Remove redundant functions and typedef
   2022-11-23 17:21:30 by Adam Ciarcinski | Files touched by this commit (1878) | Package updated
Log message:
massive revision bump after textproc/icu update