diff options
| author | Dimitri van Heesch <doxygen@gmail.com> | 2020-04-12 21:08:11 (GMT) |
|---|---|---|
| committer | Dimitri van Heesch <doxygen@gmail.com> | 2020-04-12 21:08:11 (GMT) |
| commit | 6c4e14b2cedc333e8989a38a4cd2726b168bcbaf (patch) | |
| tree | 7b4eff5a32eae0317fb7d168dcb9b7900b4b97a0 | |
| parent | 184ea443799cd27a1e3cd3989c03c183297df890 (diff) | |
| download | Doxygen-6c4e14b2cedc333e8989a38a4cd2726b168bcbaf.zip Doxygen-6c4e14b2cedc333e8989a38a4cd2726b168bcbaf.tar.gz Doxygen-6c4e14b2cedc333e8989a38a4cd2726b168bcbaf.tar.bz2 | |
Updated changelog for version 1.8.18
| -rwxr-xr-x | doc/changelog.doc | 2716 | ||||
| -rw-r--r-- | src/CMakeLists.txt | 4 |
2 files changed, 1447 insertions, 1273 deletions
diff --git a/doc/changelog.doc b/doc/changelog.doc index 6f98f47..8afa378 100755 --- a/doc/changelog.doc +++ b/doc/changelog.doc @@ -2,6 +2,176 @@ \tableofcontents{html,latex} \section log_1_8 1.8 Series +\subsection log_1_8_18 Release 1.8.18 +\htmlonly +<b>(release date 12-04-2020)</b> +<a name="1.8.18"></a> +</p> +<h3>Removed functionality</h3> +<ul> +<li>Removed support for TCL (code is too buggy and unmaintained, language not very popular) [<a href="https://github.com/doxygen/doxygen/commit/48a7afc0caf69857a42b0fe1963db3440cb4000f">view</a>]</li> +</ul> +<h3>Bug fixes</h3> +<ul> +<li>Bug 769411 - Confuses functions with the same name, but different namespace [<a href="https://github.com/doxygen/doxygen/commit/997e2b91f64e7f33898560bd935fddfc852f769e">view</a>]</li> +<li>Bug 779650 - Typo in https://www.stack.nl/~dimitri/doxygen/manual/docblocks.html [<a href="https://github.com/doxygen/doxygen/commit/175f86cde5552d4daf7b5e29d9a9a4271acaf8ef">view</a>]</li> +<li>Bug 780630 - Nested @ingroup generates bad breadclumb list [<a href="https://github.com/doxygen/doxygen/commit/134b336c018f8a1cd66acc9922f12387e9a1dbcf">view</a>]</li> +<li>Bug 791390 - Table formatting information ignored in Doxygen XML output [<a href="https://github.com/doxygen/doxygen/commit/09939f6fd8b1e7aaa29016e09ef47047e7bea75b">view</a>]</li> +<li>issue #6319: C++ function returning std::function with reference argument is not recognized as a function (Origin: bugzilla #792830) [<a href="https://github.com/doxygen/doxygen/commit/f39ee0710bff1d788a690d982a2e1312861c0f73">view</a>]</li> +<li>issue #6901: Please consider relicensing of Javascript files [<a href="https://github.com/doxygen/doxygen/commit/3470dd71ff483bc21d92aae936ece9d40de2f861">view</a>]</li> +<li>issue #7411: "warning: return type of member is not documented" for static void and virtual void functions [<a href="https://github.com/doxygen/doxygen/commit/6c10868a2b31076e8f5e42af0036b43e7f39d2b2">view</a>]</li> +<li>issue #7432: vhdl-fixed-bug-7432 [<a href="https://github.com/doxygen/doxygen/commit/abd887af5cb3e70f801848adb87c70642e6fb1dc">view</a></li> +<li>issue #7464: test suite is failing [<a href="https://github.com/doxygen/doxygen/commit/cd9dee013dc749a10bbe019c350e0e62b6635795">view</a>]</li> +<li>issue #7472: Serious regression: /**< comments cause functions to be silently ignored [<a href="https://github.com/doxygen/doxygen/commit/eace8c9e3ceb14fb80c6f548713624fd743f7276">view</a>]</li> +<li>issue #7474: [1.8.16 regression] HTML output varies from ASLR [<a href="https://github.com/doxygen/doxygen/commit/dc67dbe5bd5a48756c591ad02b9f68fbd2a57687">view</a>]</li> +<li>issue #7477: Broken urls in the xml output [<a href="https://github.com/doxygen/doxygen/commit/2f79c6938c6d969f3d4ebc9ed0f2648668434502">view</a>]</li> +<li>issue #7484: Error: /undefined in getenv [<a href="https://github.com/doxygen/doxygen/commit/4c20acdb98eed7928015ed8d6ed739db0ccdaed6">view</a>]</li> +<li>issue #7508: TYPEDEF_HIDES_STRUCT stopped working properly [<a href="https://github.com/doxygen/doxygen/commit/e468a6944f24152080c2a9b322c6623bfff208b4">view</a>]</li> +<li>issue #7527: Doxygen 1.8.17: regression of C macro expansion [<a href="https://github.com/doxygen/doxygen/commit/938b6dfd1cb5173aa6ab19aa848ae266dba0afff">view</a>]</li> +<li>issue #7544: [Regression 1.8.17] Recursion when computing class usage relations [<a href="https://github.com/doxygen/doxygen/commit/2faf90d076b3e1ec2d13597341cb8220fe15be9f">view</a>]</li> +<li>issue #7558: PlantUML: Different behavior whether LATEX_OUTPUT has a final slash or not. [<a href="https://github.com/doxygen/doxygen/commit/6d3d15af681da52873f643f3952b6efcba40f1a8">view</a>]</li> +<li>issue #7570: Comments replaced by block comments inside Markdown code block [<a href="https://github.com/doxygen/doxygen/commit/137328681e7dcbd07a5ec0e4b068aea96ec41b4a">view</a>], [<a href="http://github.com/doxygen/doxygen/commit/3cbb8b8b56cb56f9cca84740baa065cb07997f90">view</a>]</li> +<li>issue #7583: External Links in Inheritance Diagrams open in the Image Frame. [<a href="https://github.com/doxygen/doxygen/commit/8a7647bd12f383730c886b34c431ae976ec5ff83">view</a>]</li> +<li>issue #7585: Doxygen 1.8.17 false warnings and no generate output for documented const functions [<a href="https://github.com/doxygen/doxygen/commit/8075ba0bbe45e1692c678bedd03a14ff167a0b8c">view</a>]</li> +<li>issue #7590: Map .f18 filetype to Fortran [<a href="https://github.com/doxygen/doxygen/commit/c641d203a2fd602654ca62b0a651b097a53a7b93">view</a>], [<a href="http://github.com/doxygen/doxygen/commit/c918f35f7335b24a4963de37cdda5407764abc2e">view</a>]</li> +<li>issue #7606: Unable to build "master" branch [<a href="https://github.com/doxygen/doxygen/commit/57de6d693923b11c41d90574acb3a3b4feb0b160">view</a>]</li> +<li>issue #7624: non-const getClassDef() called on aliased member. Please report as a bug. [<a href="https://github.com/doxygen/doxygen/commit/7f8fbc326ba6a9f6bb643983ca12a31b40fa7c00">view</a>]</li> +<li>issue #7635: Incorrect location for enum in XML file [<a href="https://github.com/doxygen/doxygen/commit/7296e6bf11ff98e100ff3768381c8411fe57f8e1">view</a>] and [<a href="https://github.com/doxygen/doxygen/commit/43420bd77408559cb66c83e9ce601426b371bc74">view</a>] and [<a href="https://github.com/doxygen/doxygen/commit/0f9075aefb620bbef4609111289ff6255ac15cd3">view</a>]</li> +<li>issue #7652: folder in file list has file icon (#7654) [<a href="https://github.com/doxygen/doxygen/commit/022dfa0527cc79a597a7b06db87dcb2f8b19eca7">view</a>]</li> +<li>issue #7660: In the ceph package error: non-const getNamespaceDef() called on aliased member. [<a href="https://github.com/doxygen/doxygen/commit/e4070d58bb8d8ee8fe63c33480732b963f33c23f">view</a>]</li> +<li>issue #7664: bigobj not found with MSYS Makefiles [<a href="https://github.com/doxygen/doxygen/commit/eab35a39804e4ccac521057112f138d3e32efac9">view</a>]</li> +<li>issue #7672: Request: use <img> tags instead of <object> tags for SVG images [<a href="https://github.com/doxygen/doxygen/commit/2d91d8c497855600e1ab107d6edc358dcade18e0">view</a>]</li> +<li>issue #7674: Mention EXTRACT_ALL in the context of /file [<a href="https://github.com/doxygen/doxygen/commit/1d403d6449ef632d94ac0973c9128ddb584ffc6a">view</a>]</li> +<li>issue #7692: \copydoc does not work with file paths including dots [<a href="https://github.com/doxygen/doxygen/commit/f929c5991b92678c167b82a9171777fef11672f1">view</a>]</li> +<li>issue #7514: Missing parenthesis for typedef function pointer [<a href="https://github.com/doxygen/doxygen/commit/cbeaf5763aef97b1f116c9996cb69c74133162bc">view</a>]</li> +<li>A mainpage doesn't have an anchor to jump to [<a href="https://github.com/doxygen/doxygen/commit/77feb077388e2539c17b9709750553d7454626f2">view</a>]</li> +<li>Avoid unsupported html attributes from appearing in the XML/docbook output and other small fixes [<a href="https://github.com/doxygen/doxygen/commit/90fb3132ce02eb44abe3797954267fefcb8d10a8">view</a>]</li> +<li>Crash of doxygen on not understood code [<a href="https://github.com/doxygen/doxygen/commit/a73a6388956714f4a0dbd07259d0aa1ed4ddaf03">view</a>]</li> +<li>Fix CROS javascript issue when giving focus to search result frame. [<a href="https://github.com/doxygen/doxygen/commit/2f66c80e7d59f2dd22036b17e77a48e547705d96">view</a>]</li> +<li>Disappearing words in RTF output after a list [<a href="https://github.com/doxygen/doxygen/commit/8c565720187f27a325b6fa4e1f2fa8e92ae6615a">view</a>]</li> +<li>Consistency `\*only` and `\end*only` commands [<a href="https://github.com/doxygen/doxygen/commit/93a6f04ac6f9df7c66b704b24383e3d239fc7c17">view</a>]</li> +<li>Showing information from all `*only commands in XML output [<a href="https://github.com/doxygen/doxygen/commit/afe51035be938b90b1790aa40937a93207ccdd34">view</a>]</li> +<li>Fix #7490 and #7494 [<a href="https://github.com/doxygen/doxygen/commit/05c7c93281332adfc92e49c9f3ffd2715065e1ac">view</a>]</li> +<li>Fix 6342: Applying provided patch [<a href="https://github.com/doxygen/doxygen/commit/323f983a7b3b76cd309acbc743391a9e6829c244">view</a>]</li> +<li>Fix build error after 'make clean' due to creation of unpatched JavaCC.h [<a href="https://github.com/doxygen/doxygen/commit/b107d3412b12c37a6b87c7315bc4039446cd3338">view</a>]</li> +<li>Fix compiler warnings on Windows (Visual Studio) [<a href="https://github.com/doxygen/doxygen/commit/f6cd1a9f2da30c33b80955c061f5a106ae4fdf42">view</a>]</li> +<li>Fix double ended list in changelog.doc [<a href="https://github.com/doxygen/doxygen/commit/a9268b0b29ebe10c6752466e9f290afa81f68913">view</a>]</li> +<li>Fix for Portable::isAbsolutePath [<a href="https://github.com/doxygen/doxygen/commit/b8f3c3ddf91f5ae71d5a012f188461259b2f7e69">view</a>]</li> +<li>Fix for compilation issue on Linux [<a href="https://github.com/doxygen/doxygen/commit/84951f8ee67a7000fe617b73f7e50b9495763ad9">view</a>]</li> +<li>Fix for compile issue on Travis-CI [<a href="https://github.com/doxygen/doxygen/commit/77ba85cf74d85ebf68c69d7d42e33839902e2f97">view</a>]</li> +<li>Fix for potential crash when processing VHDL [<a href="https://github.com/doxygen/doxygen/commit/abb7f5372f3646d8dc70fb5c47344dc9250d8b2c">view</a>]</li> +<li>Fix for removed spaces in certain \if \else \endif constructs [<a href="https://github.com/doxygen/doxygen/commit/ac3ad1e58da96a28cb09cb9fab5b34837bc1c292">view</a>]</li> +<li>Fix for unused variable JAVASCRIPT_LICENSE_TEXT. [<a href="https://github.com/doxygen/doxygen/commit/1b071a1ac3bf0f5be8026a6f4ff61c05995b48b3">view</a>]</li> +<li>Fix html file ext in external docs (#7679) [<a href="https://github.com/doxygen/doxygen/commit/e40d6588c22f465d9cdd17a58f089031ebab581b">view</a>]</li> +<li>Fix not correctly formatted messages [<a href="https://github.com/doxygen/doxygen/commit/dcd90f9779e3d2608e4c1e9225d1c0e5c12249f9">view</a>]</li> +<li>Fix regression when creating directory graphs [<a href="https://github.com/doxygen/doxygen/commit/30887ace1d06cc76bdd1b5aa3895e21dc39fddab">view</a>]</li> +<li>Fix the problem character string between '<' and '>' is not output in doxywizard log. (#7631) [<a href="https://github.com/doxygen/doxygen/commit/7c3b332d233965544467f5e84e249e5985587cb2">view</a>]</li> +<li>Fix wrongly detecting ``` as code block inside running text. [<a href="https://github.com/doxygen/doxygen/commit/dc7729800038933a099f2b1c6409ee5210e248bb">view</a>]</li> +<li>Fixed error in Windows build [<a href="https://github.com/doxygen/doxygen/commit/4a7d454f0e9a637a0d68ba38ea36b0d780e69648">view</a>]</li> +<li>Fixed indenting in French translation so as to minimize differences with the English version [<a href="https://github.com/doxygen/doxygen/commit/b06437c30311e1b3611bd34d5a3aa2cdd5f854a2">view</a>]</li> +<li>Fixed minor typo (#7637) [<a href="https://github.com/doxygen/doxygen/commit/ef07bc9fb2fc86d30f4a6781c4b0c48564d27b03">view</a>]</li> +<li>Fixed section type setting for index page from tags file. (#7684) [<a href="https://github.com/doxygen/doxygen/commit/4b5a3c19573ae5e9a6e6ade8aca9fbe9f307bbd2">view</a>]</li> +<li>Fixed shadowing issue in getFortranDefs and other shadowing cases [<a href="https://github.com/doxygen/doxygen/commit/bc83eb68e2fd31faa4b1ca7bb6610b30c0a24659">view</a>]</li> +<li>Fixed sig11 regression while parsing cast to function pointer [<a href="https://github.com/doxygen/doxygen/commit/a825e8dc7bf8a3fc8fac24d601a4107f552fa5db">view</a>], [<a href="http://github.com/doxygen/doxygen/commit/d0622bb6c0c607d8c974e46ee4c77f01ac0d40cc">view</a>]</li> +<li>Fixed typo [<a href="https://github.com/doxygen/doxygen/commit/d0705323ef3fdc1db315ee8cd8326a7d0da5ced7">view</a>]</li> +<li>Fixup condition-variable and mutex [<a href="https://github.com/doxygen/doxygen/commit/d47343e2a932c2b7834850ed903943c635f7bd3c">view</a>]</li> +<li>Incorrect determination of fixed form Fortran [<a href="https://github.com/doxygen/doxygen/commit/f4a10139c6652a122912754ccc0b453e703c92bf">view</a>]</li> +<li>Incorrect link generated for cite and xref (#7648) [<a href="https://github.com/doxygen/doxygen/commit/d165a89863eab073702afb0e19b44cf2e85f7db5">view</a>]</li> +<li>Function definitions at begin of a line [<a href="https://github.com/doxygen/doxygen/commit/98302da8f020c339960617761a8e5a4dd602f5ca">view</a>]</li> +<li>Incorrect handling of typedef in combination with const [<a href="https://github.com/doxygen/doxygen/commit/e5451841b6e54171c0124e32a2773153ff3de922">view</a>]</li> +<li>Link in case of comma at end of URL [<a href="https://github.com/doxygen/doxygen/commit/c7ab46f20fa5a7ac219dc6368daeccf381cd47f6">view</a>]</li> +<li>Minor fixes for table cell attributes in XML and docbook output [<a href="https://github.com/doxygen/doxygen/commit/93245ad926ce01720eb35b9cf000992a44ac85c0">view</a>]</li> +<li>Missing anchors in RTF code output (#7647) [<a href="https://github.com/doxygen/doxygen/commit/f788f684f055c5470d624f3c27c6e236f18c2c31">view</a>]</li> +<li>Opening and ending tag mismatch: tbody in docbook output [<a href="https://github.com/doxygen/doxygen/commit/e427e3b1e2a03af6d87b7d46996aabafde454bcc">view</a>]</li> +<li>Problem in case using PREDEFINED with comma [<a href="https://github.com/doxygen/doxygen/commit/00b45f73c67f5c57407e6e2a783af7f0820afa4d">view</a>]</li> +<li>Problem in case using PREDEFINED with comma and using += [<a href="https://github.com/doxygen/doxygen/commit/5a0cfa3bd29d8643c7744d03d8fba4ae990aa260">view</a>]</li> +<li>Problem with links from search index files [<a href="https://github.com/doxygen/doxygen/commit/7bb28cb61ee12edf77aa0c368eaf747fb162bad9">view</a>]</li> +<li>Problem with temporary / intermediate directory in doxyparse [<a href="https://github.com/doxygen/doxygen/commit/57662b4051d9c861e089072ed3dc6409f81ff3f7">view</a>]</li> +</ul> +<h3>Features</h3> +<ul> +<li>Added the few missing French translations [<a href="https://github.com/doxygen/doxygen/commit/8d71db8f1c30f2f6e746e705501a269144cd1260">view</a>]</li> +<li>Updated Swedish translation to match the latest version [<a href="https://github.com/doxygen/doxygen/commit/ffe779e1a06157ec9005bc6fa7759fe8c74f4a60">view</a>]</li> +<li>Adding check on configuration setting EXTENSION_MAPPING [<a href="https://github.com/doxygen/doxygen/commit/ece9bb503529d92e366554c6852d868d48ada8cb">view</a>]</li> +<li>Adding commands `\rtfinclude`, `\docbookinclude`, `\maninclude` and `\xmlinclude` [<a href="https://github.com/doxygen/doxygen/commit/b59182f64dcb75bd9b7ddcb31e28fae459c4cf03">view</a>]</li> +<li>output on doxyparse if a function is a prototype [<a href="https://github.com/doxygen/doxygen/commit/f5a91767dc32230f7fc39d78d42d3f16a8961895">view</a>]</li> +<li>print protection information on doxyparse [<a href="https://github.com/doxygen/doxygen/commit/c6b9eb426893e294d6a2f9261d689d25fe5fa546">view</a>]</li> +<li>Creation of svg images for formulas with inkscape [<a href="https://github.com/doxygen/doxygen/commit/d32c7f52414d6a2bcb8b2a62bb780333348000be">view</a>]</li> +<li>Improve formula handling and rendering. [<a href="https://github.com/doxygen/doxygen/commit/10b2b8fc694b60a17ccd2642f3a40c851e33b9da">view</a>]</li> +<li>Doxygen version in the messages output (#7640) [<a href="https://github.com/doxygen/doxygen/commit/ffd222f0bb26e6b9fb696bfda60a5f675cae1514">view</a>]</li> +<li>Doxygen version information (#7645) [<a href="https://github.com/doxygen/doxygen/commit/39ba759f4dba837818f07451314b3612d438a1bd">view</a>]</li> +<li>Enabling Travis builds for s390x [<a href="https://github.com/doxygen/doxygen/commit/83af252278a91518e1ee362136df9f746a7a2650">view</a>]</li> +<li>Relative markdown file reference (#7032) [<a href="https://github.com/doxygen/doxygen/commit/307a912cc0e4e080c49e4b47f2c8f5a7ffb605ba">view</a>]</li> +</ul> +<h3>Refactoring and cleanup</h3> +<ul> +<li>Add documentation to section.h [<a href="https://github.com/doxygen/doxygen/commit/d391530e102a919d8b0a51ecb74b1815b896bc27">view</a>]</li> +<li>Add printf-Checks to message.h [<a href="https://github.com/doxygen/doxygen/commit/8aead913d6a8285c2949f93147efaec5f7b357d8">view</a>]</li> +<li>Added missing #includes [<a href="https://github.com/doxygen/doxygen/commit/6511573f661d3f8eacc6d316222fd77b98720d6a">view</a>]</li> +<li>CMake and examples [<a href="https://github.com/doxygen/doxygen/commit/f06f4276189066cad0a5dbd291c1e7021ab87b44">view</a>]</li> +<li>Cleanup code [<a href="https://github.com/doxygen/doxygen/commit/023b07ca13263a9d6d50ffa806d5aad35e31c869">view</a>]</li> +<li>Cleanup unused/unwanted parser dependencies on code generator [<a href="https://github.com/doxygen/doxygen/commit/9ebe579b8ccce09c174bfaca475bf628233d3944">view</a>]</li> +<li>Combined both rules in one to reduce code duplication [<a href="https://github.com/doxygen/doxygen/commit/de785c9b27fab590ae1d05de21be9391bdfb751e">view</a>]</li> +<li>Compilation warnings [<a href="https://github.com/doxygen/doxygen/commit/d65fa97b0400551720e0b3839f79a5ab8555fe84">view</a>]</li> +<li>Correct handling of error / removed debug statement [<a href="https://github.com/doxygen/doxygen/commit/bebd80f5a3715a4d3e7f1f2ed7a78ff7711c01b0">view</a>]</li> +<li>Correction behavior of make clean in respect to version files [<a href="https://github.com/doxygen/doxygen/commit/de30df322c5b8c01133a008822c691959ebf93a4">view</a>]</li> +<li>Correction due to removal of Tcl [<a href="https://github.com/doxygen/doxygen/commit/657605d0b26c0d66036073c5deeddff21ad9f6d9">view</a>]</li> +<li>Documentation correction due to removal of Tcl [<a href="https://github.com/doxygen/doxygen/commit/9b6c44d71d58a95c455ad133511bab332fe82c6c">view</a>]</li> +<li>Doxywizard unknown configuration enum values [<a href="https://github.com/doxygen/doxygen/commit/9b2564369d1769c6bce4695057c2b0184a1457e2">view</a>]</li> +<li>Enabled stricter compiler warnings and fixed all new warnings [<a href="https://github.com/doxygen/doxygen/commit/4658413ff3b9551fac67907f296a586e9f2c15ed">view</a>]</li> +<li>Fix C compiler warnings about C++ flags (#7636) [<a href="https://github.com/doxygen/doxygen/commit/01edb490daa2942227992d8a60bd3673551995bf">view</a>]</li> +<li>Fix a few compiler warnings in the Linux build [<a href="https://github.com/doxygen/doxygen/commit/107d84ae68208f51b524c2f0b933784a26d23ad3">view</a>]</li> +<li>Fix a number of compiler warnings in the 64bit build for Windows [<a href="https://github.com/doxygen/doxygen/commit/fbebfae209139fccb15fde8fb7d1bdbb4b941875">view</a>]</li> +<li>Make VHDL parser reentrant [<a href="https://github.com/doxygen/doxygen/commit/5b9bf6e3549ac9011f607cc50e764da6af347689">view</a>]</li> +<li>Make commentscan.l reentrant [<a href="https://github.com/doxygen/doxygen/commit/e55c2248b46d5580e5b184d2ff9c773f333308b2">view</a>]</li> +<li>Make defargs.l reentrant [<a href="https://github.com/doxygen/doxygen/commit/a036d6401cc457f6c80899775a471bb5ac4d5323">view</a>]</li> +<li>Make fortranscanner.l reentrant [<a href="https://github.com/doxygen/doxygen/commit/79cca781278544a7efc3a5538e2252ab399e08df">view</a>]</li> +<li>Make pyscanner.l reentrant [<a href="https://github.com/doxygen/doxygen/commit/c22852aae860d42ed3a0895926199b364dbf84db">view</a>]</li> +<li>Mention EXTRACT_ALL in the context of /file [<a href="https://github.com/doxygen/doxygen/commit/13bf5827b01d81e1b75151049113875b2a6e7d60">view</a>]</li> +<li>Migrated some code in pre.l to use STL containers [<a href="https://github.com/doxygen/doxygen/commit/b0554573d373519dbf8bc7109e0e143952ec6302">view</a>] and [<a href="https://github.com/doxygen/doxygen/commit/29f29c2eb1a75ff02624fdb2badd47dd55427841">view</a>]</li> +<li>Minor fix for formulas.doc [<a href="https://github.com/doxygen/doxygen/commit/b78abaaf9acba05b12fc3f155608198061e54e10">view</a>]</li> +<li>Minor tweaks [<a href="https://github.com/doxygen/doxygen/commit/630774460c480494d7ce66a0f91d49da60403ef4">view</a>]</li> +<li>Modernize OutputList internals [<a href="https://github.com/doxygen/doxygen/commit/7464fdd7d4a3efd97dbc24c171556d7683648c8d">view</a>]</li> +<li>More accurate warning message. [<a href="https://github.com/doxygen/doxygen/commit/f9672b168b7d3b06d845d7d0aaa039ec96f6f0c4">view</a>]</li> +<li>More indicative warning for wrong nesting of sections [<a href="https://github.com/doxygen/doxygen/commit/4281a6cb105c3b57bb8f866ec55e8ef13060c401">view</a>]</li> +<li>Move DocGroup inside CommentScanner instead of using a global [<a href="https://github.com/doxygen/doxygen/commit/8d49c7c40e59970565872f666e2110755cac7828">view</a>]</li> +<li>Possibility to use gswin64c on Windows [<a href="https://github.com/doxygen/doxygen/commit/95723b6842f52dc044c34bd0218b0661d1e59c9e">view</a>], [<a href="http://github.com/doxygen/doxygen/commit/b96dc0fd971a3569e2a986e833c2eb7f24db69f2">view</a>]</li> +<li>QString -> std::string & QDict -> std::map [<a href="https://github.com/doxygen/doxygen/commit/e0fa50b71c74a191a64a2361564a016e6f9c0204">view</a>]</li> +<li>Remove DotConstString and replace by std::string [<a href="https://github.com/doxygen/doxygen/commit/593d0591487c65d5d51246e8e6ea93c83518f6c4">view</a>]</li> +<li>Remove dead code and fix more warnings [<a href="https://github.com/doxygen/doxygen/commit/a8673fb74375089a432aa23230396335a46df5d3">view</a>]</li> +<li>Remove duplicate xsd fields for `docMarkupType`. [<a href="https://github.com/doxygen/doxygen/commit/2084f3ae9d1da27ddd420c8ffe65345598688381">view</a>]</li> +<li>Remove last QThread-Reference [<a href="https://github.com/doxygen/doxygen/commit/475b4d7388cfc408fed097d80521db289c4522b9">view</a>]</li> +<li>Remove some unused enums in doxywizard [<a href="https://github.com/doxygen/doxygen/commit/bbbf9035f9ee54c7b7b556532a6639e68c87d5c5">view</a>]</li> +<li>Remove thread-related Qt-Code [<a href="https://github.com/doxygen/doxygen/commit/739e9c039b6678b0565922f8a38e062cc83fd702">view</a>]</li> +<li>Remove unused rules [<a href="https://github.com/doxygen/doxygen/commit/ab40bb00ea1161afdc997699ace362b67916e34e">view</a>]</li> +<li>Remove warnings from doxywizard [<a href="https://github.com/doxygen/doxygen/commit/79745c1110f973ac14b4087f7c199f7c8fd02469">view</a>]</li> +<li>Removed Doxygen::gatherDefines as it was not used anymore [<a href="https://github.com/doxygen/doxygen/commit/e2157cd6d65297339419e73b53e01a7d2cd25d2c">view</a>]</li> +<li>Removing warnings from doxygen internal documentation [<a href="https://github.com/doxygen/doxygen/commit/f15360bf1445b5edfdc82fd027fdab0f29e1d8e5">view</a>]</li> +<li>Replace DocCmdMapper by std::map [<a href="https://github.com/doxygen/doxygen/commit/701388717d38b2a5063e35c87e07264099cb60cd">view</a>]</li> +<li>Replace QMutex and condition QWaitCondition with std:: [<a href="https://github.com/doxygen/doxygen/commit/e8f0640e7e80351de68b40b5114f71fe94dc5fee">view</a>]</li> +<li>Replace QThread with std::thread [<a href="https://github.com/doxygen/doxygen/commit/5a6f35b0de84350b867e06b3eb85622c4cface37">view</a>]</li> +<li>Replace SDict with std::map [<a href="https://github.com/doxygen/doxygen/commit/9ab5f68756f1555a805dda5d0215d275d3db8725">view</a>]</li> +<li>Replace qlist with std::vector [<a href="https://github.com/doxygen/doxygen/commit/00e79b8621b00f72ea56f81b1c4df9eae4ed9252">view</a>]</li> +<li>Replace qqueue with std::queue [<a href="https://github.com/doxygen/doxygen/commit/110cb591c076f84b6dee49b3fa2a1ebc107f7945">view</a>]</li> +<li>Replace raw bool pointer array and counter by std::stack<bool> [<a href="https://github.com/doxygen/doxygen/commit/734702dc761ba40533cebf3cf405071cc9b8eb20">view</a>]</li> +<li>Replaced FileNameDict/FileNameList by FileNameLinkedMap [<a href="https://github.com/doxygen/doxygen/commit/4bc2355373979726c7ed4e8351639123daf808cb">view</a>]</li> +<li>Replaced MemberNameSDict by MemberNameLinkedMap based on LinkedMap [<a href="https://github.com/doxygen/doxygen/commit/369e821fc6870e9e6b30aa13d59592c12c760800">view</a>]</li> +<li>Restructure citation handling [<a href="https://github.com/doxygen/doxygen/commit/fa520f975a0893c0d123c1cafec63206bf737794">view</a>]</li> +<li>Restructure section handling [<a href="https://github.com/doxygen/doxygen/commit/1a56a39b4a97452a5c7c2d8e9d39ab28ca33dff0">view</a>]</li> +<li>Restructure the way RefLists are handled [<a href="https://github.com/doxygen/doxygen/commit/aca13723a9373a1080ca7f108e7be0905b9ae793">view</a>]</li> +<li>Simplified the code a bit [<a href="https://github.com/doxygen/doxygen/commit/a6383d9ed3381975337e1d100427f7c022f0a247">view</a>]</li> +<li>Small spelling correction in change log [<a href="https://github.com/doxygen/doxygen/commit/288631a327a03cc383a3128623425f627d9859da">view</a>]</li> +<li>Small spelling correction in portable.cpp [<a href="https://github.com/doxygen/doxygen/commit/ba4e098a09da73738bd0f849492719bc37d36f1b">view</a>]</li> +<li>Specifying filename in preprocessor debug output [<a href="https://github.com/doxygen/doxygen/commit/8616d8e1ee61d3fc1a929a04f1594b0f417da7c2">view</a>]</li> +<li>Unknown configuration enum values [<a href="https://github.com/doxygen/doxygen/commit/9c9e30b295ca8b0a2130aa00c26bb5aa40a0e608">view</a>]</li> +<li>Updated test 024 to better test spacing behaviour. [<a href="https://github.com/doxygen/doxygen/commit/b47de248b2c4d54bd83a4c679fa6a58dbaf3fe11">view</a>]</li> +<li>Warnings in case of a VHDL error [<a href="https://github.com/doxygen/doxygen/commit/5bda6a19dcb48720ee57fc099f7ad14e4ad15b0a">view</a>]</li> +<li>commentscan.l: replace QStack by std::stack [<a href="https://github.com/doxygen/doxygen/commit/5e815d8f3dd1cad071a6152b458c08f197bb00d2">view</a>]</li> +<li>fixed some parser bugs,make parser ready for javacc 7.0.5 [<a href="https://github.com/doxygen/doxygen/commit/543a30dfcf050c772a5ef5420c821acbfe3cac9f">view</a>]</li> +</ul> +<p> +\endhtmlonly + \subsection log_1_8_17 Release 1.8.17 \htmlonly <b>(release date 27-12-2019)</b> @@ -2421,13 +2591,13 @@ href="https://github.com/doxygen/doxygen/commit/a697caadf1912d0d74faa208f4cff887 <h3>New features</h3> <ul> <li> Added support for "clang assisted parsing", which allows - the code to also be parsed via libclang (C/C++ frontend of LLVM) - and can improve the quality of the syntax highlighting, cross-references, - and call graphs, especially for template heavy C++ code. To enable - this feature you have to configure doxygen with the --with-libclang - option. Then you get two new configuration options: CLANG_ASSISTED_PARSING - to enable or disable parsing via clang and CLANG_OPTIONS to pass additional - compiler options needed to compile the files. Note that enabling this feature + the code to also be parsed via libclang (C/C++ frontend of LLVM) + and can improve the quality of the syntax highlighting, cross-references, + and call graphs, especially for template heavy C++ code. To enable + this feature you have to configure doxygen with the --with-libclang + option. Then you get two new configuration options: CLANG_ASSISTED_PARSING + to enable or disable parsing via clang and CLANG_OPTIONS to pass additional + compiler options needed to compile the files. Note that enabling this feature has a significant performance penalty.</li> <li> Included patch donated by Intel which adds Docbook support. This can be enabled via GENERATE_DOCBOOK and the output location can @@ -2435,26 +2605,26 @@ href="https://github.com/doxygen/doxygen/commit/a697caadf1912d0d74faa208f4cff887 added using \docbookonly ... \enddocbookonly</li> <li> Added support for UNO IDL (interface language used in Open/Libre Office), thanks to Michael Stahl for the patch.</li> -<li> Included patch by Adrian Negreanu which stores data gathered by +<li> Included patch by Adrian Negreanu which stores data gathered by doxygen in a sqlite3 database. Currently still work in progress and can only be enabled using --with-sqlite3 during ./configure.</li> <li> For interactive SVG graphs, edges are now highlighted when hovered by the mouse.</li> <li> Include patch by Adrian Negreanu to show duration statistics after a run. You can enable this by running doxygen with the "-d Time" option.</li> -<li> Included patch by Markus Geimer which adds a new option +<li> Included patch by Markus Geimer which adds a new option LATEX_EXTRA_FILES which works similarly to HTML_EXTRA_FILES in that it copied specified files to the LaTeX output directory.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/5149">5149</a>: Added support for C++11 keyword alignas</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/5056">5056</a>: Added support for processing DocSets with Dash (thanks to Bogdan Popescu for the patch </li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4900">4900</a>: Added option EXTERNAL_PAGES which can be used to determine - whether or not pages imported via tags will appear under related + whether or not pages imported via tags will appear under related pages (similar to EXTERNAL_GROUPS).</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/5042">5042</a>: Added new MathJax command MATHJAX_CODEFILE which supports including a file with MathJax related scripting to be inserted before the MathJax script is loaded. Thanks to Albert for the patch.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/5070">5070</a>: Comments in the config file starting with ## will now be +<li> id <a href="https://github.com/doxygen/doxygen/issues/5070">5070</a>: Comments in the config file starting with ## will now be kept when upgrading the file with doxygen -u (and doxygen -s -u). Thanks to Albert for the patch.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/5061">5061</a>: Adds support for Latvian (thanks to a patch by Lauris).</li> @@ -2470,7 +2640,7 @@ href="https://github.com/doxygen/doxygen/commit/a697caadf1912d0d74faa208f4cff887 <li> id <a href="https://github.com/doxygen/doxygen/issues/2445">2445</a>: Putting a @todo in front of an anonymous namespace caused bogus entry in the todo list.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3198">3198</a>: Fixed alignment issue with tabs and multibyte characters.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/3230">3230</a>: Character entities in titles were not rendered correctly +<li> id <a href="https://github.com/doxygen/doxygen/issues/3230">3230</a>: Character entities in titles were not rendered correctly in the HTML navigation tree.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3272">3272</a>: No space between * and tag (e.g. \endcode) made parser misbehave</li> @@ -2483,11 +2653,11 @@ href="https://github.com/doxygen/doxygen/commit/a697caadf1912d0d74faa208f4cff887 Code when starts in Line 1</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4096">4096</a>: Fortran: array constructors with brackets were not correctly recognized.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4223">4223</a>: The generated man pages had a .PP just before the subject +<li> id <a href="https://github.com/doxygen/doxygen/issues/4223">4223</a>: The generated man pages had a .PP just before the subject description</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4224">4224</a>: On generated manpages the return section is incorrectly +<li> id <a href="https://github.com/doxygen/doxygen/issues/4224">4224</a>: On generated manpages the return section is incorrectly indented</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4261">4261</a>: use \page now generates a man page were the . is not +<li> id <a href="https://github.com/doxygen/doxygen/issues/4261">4261</a>: use \page now generates a man page were the . is not replaced by _8.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4385">4385</a>: Fixed issue with PROJECT_LOGO when using backslashes in the path.</li> @@ -2499,21 +2669,21 @@ href="https://github.com/doxygen/doxygen/commit/a697caadf1912d0d74faa208f4cff887 <li> id <a href="https://github.com/doxygen/doxygen/issues/4788">4788</a>: Included patch by Albert to correctly link pages in the manual</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4850">4850</a>: Added support for single column Markdown tables.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4855">4855</a>: Incomplete documentation on doxygen -w latex</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4877">4877</a>: Doxygen crashed when structural commands (like \var) appeared +<li> id <a href="https://github.com/doxygen/doxygen/issues/4877">4877</a>: Doxygen crashed when structural commands (like \var) appeared in .md files.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4926">4926</a>: Fixed character encoding problem when multibytes characters were used in anchors.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/5013">5013</a>: Documentation before an anonymous member did not appear.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/5040">5040</a>: Fixed Markdown related indentation problem.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/5044">5044</a>: Regression: Text after @copydoc was not visible anymore.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/5046">5046</a>: Linked to external pages was done using the page label +<li> id <a href="https://github.com/doxygen/doxygen/issues/5046">5046</a>: Linked to external pages was done using the page label rather than the file name.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/5059">5059</a>: build using ./configure ; make did not work if the path contained a space.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/5060">5060</a>: Tag files are now identified by the full path instead of only the name of the tag file.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/5086">5086</a>: In some cases members were missing from the tag file.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/5079">5079</a>: Fortran: derive intent from documentation in case no +<li> id <a href="https://github.com/doxygen/doxygen/issues/5079">5079</a>: Fortran: derive intent from documentation in case no intent is specified</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/5089">5089</a>: Warning was not reported at the correct line in two cases.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/5092">5092</a>, <a href="https://github.com/doxygen/doxygen/issues/5093">5093</a>: @cond..@endcond did not work properly for removing @@ -2522,7 +2692,7 @@ href="https://github.com/doxygen/doxygen/commit/a697caadf1912d0d74faa208f4cff887 same name to the same group.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/5100">5100</a>: VHDL: fixed issue generating LaTeX output.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/5116">5116</a>: Fortran: improved handling of protected statement</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/5124">5124</a>: Fortran: Fixed issue resulting in +<li> id <a href="https://github.com/doxygen/doxygen/issues/5124">5124</a>: Fortran: Fixed issue resulting in "Stack buffers nested too deeply" error.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/5128">5128</a>: @cond was not handled properly by the preprocessor.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/5133">5133</a>: @copyright command did not end a brief description.</li> @@ -2531,7 +2701,7 @@ href="https://github.com/doxygen/doxygen/commit/a697caadf1912d0d74faa208f4cff887 <li> id <a href="https://github.com/doxygen/doxygen/issues/5152">5152</a>: Fixed problem handling @cond for #define's</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/5144">5144</a>: Fixed potential crash when searching files.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/5131">5131</a>: #include's inside namespace could result in duplicate entries.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/5132">5132</a>: Doxywizard: Labels of items are now also grayed out +<li> id <a href="https://github.com/doxygen/doxygen/issues/5132">5132</a>: Doxywizard: Labels of items are now also grayed out when an item is disabled (thanks to Albert for the patch).</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/5154">5154</a>: Changed Markdown page label to support multiple .md files with the same name.</li> @@ -2546,7 +2716,7 @@ href="https://github.com/doxygen/doxygen/commit/a697caadf1912d0d74faa208f4cff887 <li> id <a href="https://github.com/doxygen/doxygen/issues/5164">5164</a>: Template parameters and Exceptions were rendered differently than Parameters and Return Values in the LaTeX output.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/"></a>: Tcl: Fixed crash when parsing certain Tcl code.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/5171">5171</a>: Comment blocking ending with ///// made slashes appear in +<li> id <a href="https://github.com/doxygen/doxygen/issues/5171">5171</a>: Comment blocking ending with ///// made slashes appear in the output.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/5180">5180</a>: Added support for separating auto list items with an empty paragraph.</li> @@ -2568,11 +2738,11 @@ href="https://github.com/doxygen/doxygen/commit/a697caadf1912d0d74faa208f4cff887 </p> <h3>Changes</h3> <ul> -<li> Changed to way the search results for multiple projects can be linked +<li> Changed to way the search results for multiple projects can be linked together. A project is now no longer identified by the tag files name but via new option EXTERNAL_SEARCH_ID giving a bit more flexibility.</li> <li> Disabled the disk cache for member data. Allows removing quite some complexity - in doxygen and is not really needed now that 64bit systems with >4GB RAM + in doxygen and is not really needed now that 64bit systems with >4GB RAM are becoming more common. Let me know if you think you benefit from this caching.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/5031">5031</a>: Using $relpath$ in a custom footer could lead to ambiguities when followed by a name that could also be a marker, like 'search'. @@ -2583,47 +2753,47 @@ href="https://github.com/doxygen/doxygen/commit/a697caadf1912d0d74faa208f4cff887 <ul> <li> You can now use EXTENSION_MAPPING on files without any extension using no_extension as placeholder (thanks to Jason Majors for the patch).</li> -<li> To make navindex section inside a layout file that links to +<li> To make navindex section inside a layout file that links to a specific URL you can use usergroup with the url attribute.</li> -<li> To make navindex section without any link inside a layout file you +<li> To make navindex section without any link inside a layout file you can use usergroup with special title [none].</li> </ul> <h3>Bug fixes</h3> <ul> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4191">4191</a>: Fortran: Included patch to improve parsing line continuation +<li> id <a href="https://github.com/doxygen/doxygen/issues/4191">4191</a>: Fortran: Included patch to improve parsing line continuation characters.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4204">4204</a>: Fortran: added support for protected attribute</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4859">4859</a>, <a href="https://github.com/doxygen/doxygen/issues/5023">5023</a>: When using @copydoc, paragraphs breaks did not appear +<li> id <a href="https://github.com/doxygen/doxygen/issues/4859">4859</a>, <a href="https://github.com/doxygen/doxygen/issues/5023">5023</a>: When using @copydoc, paragraphs breaks did not appear in the copied documentation.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4930">4930</a>: Fortran: handle single quotes in normal Fortran comment.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4931">4931</a>, <a href="https://github.com/doxygen/doxygen/issues/5025">5025</a>: Scope of forwardly declared template class was lost +<li> id <a href="https://github.com/doxygen/doxygen/issues/4931">4931</a>, <a href="https://github.com/doxygen/doxygen/issues/5025">5025</a>: Scope of forwardly declared template class was lost in the output.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4978">4978</a>: Tcl: Inline source code was not rendered correctly.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/5005">5005</a>: Fixed case were a cyclic inheritance relation could crash +<li> id <a href="https://github.com/doxygen/doxygen/issues/5005">5005</a>: Fixed case were a cyclic inheritance relation could crash doxygen.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/5008">5008</a>: Using @subpage in a -# style list was not handled properly.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/5012">5012</a>: For a mainpage without title the project name is now shown as the title in the XML output.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/5017">5017</a>: The generated list of citations is now no longer included in +<li> id <a href="https://github.com/doxygen/doxygen/issues/5017">5017</a>: The generated list of citations is now no longer included in the tag file.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/5014">5014</a>: Documenting strongly typed enum values outside of the enum +<li> id <a href="https://github.com/doxygen/doxygen/issues/5014">5014</a>: Documenting strongly typed enum values outside of the enum did not work.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/5022">5022</a>: Python: = was missing in the output for variable assignment.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/5024">5024</a>: Doxygen could crash when creating inline msc graphs.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/5026">5026</a>: Members didn't have a More.. link to jump to detailed docs.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/5030">5030</a>: Doxygen did not probably distinguish between two template</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/5034">5034</a>: regression: C++ style comments that started with a line of +<li> id <a href="https://github.com/doxygen/doxygen/issues/5034">5034</a>: regression: C++ style comments that started with a line of slashes did not get processed correctly anymore. </li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/5038">5038</a>: Fixed parse error when left shift operator occurred as a +<li> id <a href="https://github.com/doxygen/doxygen/issues/5038">5038</a>: Fixed parse error when left shift operator occurred as a default parameter. members or functions that only differ in the return type.</li> <li> Setting SEARCH_INCLUDES to NO resulted in no include graphs and no include files being listed in the output.</li> <li> Improved support for MinGW (thanks to a patch by Brecht Sanders).</li> -<li> Removed the Graphviz/dot dependency when building the doxygen +<li> Removed the Graphviz/dot dependency when building the doxygen documentation.</li> <li> Anchors to sub pages were wrong in the XML output.</li> -<li> Included VHDL patch by Martin Kreis that improves the flow chart +<li> Included VHDL patch by Martin Kreis that improves the flow chart generation.</li> <li> corrected several code pages and fontsets for proper RTF output for a number of languages such as Greek.</li> @@ -2637,18 +2807,18 @@ href="https://github.com/doxygen/doxygen/commit/a697caadf1912d0d74faa208f4cff887 </p> <h3>Changes</h3> <ul> -<li> Expanding the tree in an index page of the HTML output, will now +<li> Expanding the tree in an index page of the HTML output, will now expand only one level instead of the whole sub-tree (thanks to Pez Cuckow for the patch).</li> <li> A blockquote in Markdown does no longer require a whitespace after the last '>' if the '>' is followed by a newline.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4863">4863</a>: Included patch to add version info to all generated +<li> id <a href="https://github.com/doxygen/doxygen/issues/4863">4863</a>: Included patch to add version info to all generated template files (headers, footers, stylesheets, layout files, etc).</li> </ul> <h3>New features</h3> <ul> -<li> Added support for using external tools to index and search through - the HTML documentation. An example index tool is provided (doxyindexer) +<li> Added support for using external tools to index and search through + the HTML documentation. An example index tool is provided (doxyindexer) and an example search engine (doxysearch.cgi). To configure the external search engine the following new options are added to the configuration file: EXTERNAL_SEARCH (to enable the @@ -2658,16 +2828,16 @@ href="https://github.com/doxygen/doxygen/commit/a697caadf1912d0d74faa208f4cff887 See the <a href="extsearch.html">manual</a> for details.</li> <li> Added USE_MDFILE_AS_MAINPAGE config option to select a markdown page to be used as the main page.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/3945">3945</a>: This patch (contributed by Albert) adds support for +<li> id <a href="https://github.com/doxygen/doxygen/issues/3945">3945</a>: This patch (contributed by Albert) adds support for simple logic expressions for \cond, \if, and friends, i.e. you can do \if (SOME_SECTION_NAME && (!THIS_ALTERNATIVE || THAT_ALTERNATIVE))</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4888">4888</a>: Patch (contributed by Albert) adds a new configuration +<li> id <a href="https://github.com/doxygen/doxygen/issues/4888">4888</a>: Patch (contributed by Albert) adds a new configuration option MATHJAX_FORMAT to select the MathJax output format. Options are HTML-CSS, NativeMML, or SVG.</li> </ul> <h3>Bug fixes</h3> <ul> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4584">4584</a>: Fixed compile issues with 0 to QCString cast for +<li> id <a href="https://github.com/doxygen/doxygen/issues/4584">4584</a>: Fixed compile issues with 0 to QCString cast for old compilers.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4752">4752</a>: A class A deriving from another class B inside a namespace not known to doxygen, caused class B to appear in the global scope.</li> @@ -2683,7 +2853,7 @@ href="https://github.com/doxygen/doxygen/commit/a697caadf1912d0d74faa208f4cff887 <li> id <a href="https://github.com/doxygen/doxygen/issues/4853">4853</a>: Improved SIGINT handling when running multiple dot instances.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4860">4860</a>: Fixed problem processing .bib files when using a non default output directory.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4862">4862</a>: Comment for IDL_PROPERTY_SUPPORT in the config file template +<li> id <a href="https://github.com/doxygen/doxygen/issues/4862">4862</a>: Comment for IDL_PROPERTY_SUPPORT in the config file template did not have line wrapping.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4864">4864</a>: Setting SHOW_FILES to NO prevented call graphs from being generated.</li> @@ -2691,16 +2861,16 @@ href="https://github.com/doxygen/doxygen/commit/a697caadf1912d0d74faa208f4cff887 <li> id <a href="https://github.com/doxygen/doxygen/issues/4872">4872</a>: Fortran: ALIASes where not replaced in !! and !< comments.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4886">4886</a>: Added meta tag "generator" to HTML output (thanks to Albert for the patch).</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4899">4899</a>: Sections of the main page did not appear in the +<li> id <a href="https://github.com/doxygen/doxygen/issues/4899">4899</a>: Sections of the main page did not appear in the navigation tree until the main page had sub pages. Also fixed bug in treeview that caused mainpage with title and sections to appear at the same level as the sections.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4908">4908</a>: Doxygen could select the wrong overloaded method when - the only difference in parameter types was the template type of +<li> id <a href="https://github.com/doxygen/doxygen/issues/4908">4908</a>: Doxygen could select the wrong overloaded method when + the only difference in parameter types was the template type of a typedef.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4909">4909</a>: Inheriting member documentation did not work in combination with Java interfaces.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4915">4915</a>: Enum values did not appear in the detailed documentation +<li> id <a href="https://github.com/doxygen/doxygen/issues/4915">4915</a>: Enum values did not appear in the detailed documentation when using C++11 style enums.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4920">4920</a>: Even though HIDE_UNDOC_MEMBERS was enabled, the navigation still showed undocumented members.</li> @@ -2709,7 +2879,7 @@ href="https://github.com/doxygen/doxygen/commit/a697caadf1912d0d74faa208f4cff887 <li> id <a href="https://github.com/doxygen/doxygen/issues/"></a>: Added XML declaration to index.qhp TOC.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4932">4932</a>: When a class and its base class has the same nested class, the collaboration diagram could point to the wrong class.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4934">4934</a>: Comments inside a function macro parameter appeared before +<li> id <a href="https://github.com/doxygen/doxygen/issues/4934">4934</a>: Comments inside a function macro parameter appeared before the expanded macro, instead of being treated as part of the parameter.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4936">4936</a>: Allow minus in the name of a HTML attribute.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4939">4939</a>: Code fragments were wrapped too early in the latex output.</li> @@ -2727,16 +2897,16 @@ href="https://github.com/doxygen/doxygen/commit/a697caadf1912d0d74faa208f4cff887 <li> id <a href="https://github.com/doxygen/doxygen/issues/4969">4969</a>: Correct link in documentation of SIP_SUPPORT option.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4979">4979</a>: Fixed bug that could prevent refman.tex from being generated.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4980">4980</a>: Fixed missing space in Chinese translation.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4989">4989</a>: Files added via HTML_EXTRA_STYLESHEET did not correct refer +<li> id <a href="https://github.com/doxygen/doxygen/issues/4989">4989</a>: Files added via HTML_EXTRA_STYLESHEET did not correct refer to files that where placed in a subdirectory.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4991">4991</a>: Searching for multibyte characters did not work with the +<li> id <a href="https://github.com/doxygen/doxygen/issues/4991">4991</a>: Searching for multibyte characters did not work with the server based search engine.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4993">4993</a>: Fixed case where line numbers got out of sync with the code.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4994">4994</a>: First member of an anonymous C++11 style enum was not shown properly.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4995">4995</a>: Fixed case where _'s where falsely converted to Markdown +<li> id <a href="https://github.com/doxygen/doxygen/issues/4995">4995</a>: Fixed case where _'s where falsely converted to Markdown emphasis.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4996">4996</a>: Title not used when \ref'ing to a \section imported via +<li> id <a href="https://github.com/doxygen/doxygen/issues/4996">4996</a>: Title not used when \ref'ing to a \section imported via a tag file.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4997">4997</a>: Behavior of @cond was accidentally reversed by new expression parser.</li> @@ -2753,7 +2923,7 @@ href="https://github.com/doxygen/doxygen/commit/a697caadf1912d0d74faa208f4cff887 load when using Chrome.</li> <li> HTML Navigation tree showed static members even when EXTRACT_STATIC was set to NO.</li> -<li> Same word could appear multiple times in the match list for an entry +<li> Same word could appear multiple times in the match list for an entry in the search results when using server based search.</li> </ul> <p> @@ -2765,8 +2935,8 @@ href="https://github.com/doxygen/doxygen/commit/a697caadf1912d0d74faa208f4cff887 </p> <h3>Changes</h3> <ul> -<li> Using a fenced block (~~~~) in Markdown without explicit extension will - now be interpreted as a @code..@endcode block instead +<li> Using a fenced block (~~~~) in Markdown without explicit extension will + now be interpreted as a @code..@endcode block instead of @verbatim..@endverbatim.</li> <li> Classes inheriting from an class that is outside the scope of doxygen are still shown in diagrams. This does not hold for usage relations.</li> @@ -2777,46 +2947,46 @@ href="https://github.com/doxygen/doxygen/commit/a697caadf1912d0d74faa208f4cff887 <ul> <li> strongly typed enums, e.g.: <pre>enum class E</pre></li> - <li> enums with explicit type, e.g.: + <li> enums with explicit type, e.g.: <pre>enum E : unsigned int { ... }</pre></li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4749">4749</a>: added support for final keyword on classes and methods.</li> <li> support for override keyword for methods.</li> <li> <code>nullptr</code> is new a type keyword in code fragments.</li> - <li> support for variables with initializer lists, + <li> support for variables with initializer lists, e.g.: <pre>const int var {10};</pre></li> - <li> support for trailing return types, + <li> support for trailing return types, e.g.: <pre>auto foo() -> Bar;</pre></li> - <li> id <a href="https://github.com/doxygen/doxygen/issues/4624">4624</a>: added support for template aliases, + <li> id <a href="https://github.com/doxygen/doxygen/issues/4624">4624</a>: added support for template aliases, e.g.: <pre>template<typename T> using A = B<T>;</pre></li> - <li> support for C++11 variadic templates, + <li> support for C++11 variadic templates, e.g.: <pre>template<typename... Values> class C;</pre></li> <li> support for documenting template class declarations.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4807">4807</a>: <code>static_assert(...);</code> inside a class is now ignored.</li> - <li> id <a href="https://github.com/doxygen/doxygen/issues/4793">4793</a>: Add support parameters with default lambda functions, + <li> id <a href="https://github.com/doxygen/doxygen/issues/4793">4793</a>: Add support parameters with default lambda functions, e.g.: <pre>int foo(int i, std::function<int(int)> f = [](int x) -> int { return x / 2; })</pre></li> - <li> default initializers for non-static data members, + <li> default initializers for non-static data members, e.g.: <pre>class C { public: int x = 4; int y {6}; int z = y*func(); };</pre></li> - <li> support for decltype as a way selecting a type for a variable, + <li> support for decltype as a way selecting a type for a variable, e.g.: <pre>int x; decltype(x) y;</pre></li> - <li> support for new string literals, + <li> support for new string literals, e.g. <pre>u8"utf8", u"utf-16", U"utf-32", L"wchar"</pre></li> - <li> support for raw string literals (with and without user defined - delimiter), + <li> support for raw string literals (with and without user defined + delimiter), e.g. <pre>R"(some"thing)", u8R"raw(some)"thing)raw"</pre></li> - <li> support for explicitly deleted and defaulted special members + <li> support for explicitly deleted and defaulted special members (<code>=default</code> and <code>=delete</code>).</li> </ul></li> -<li> Made several improvements to the way Objective-C categories and protocols +<li> Made several improvements to the way Objective-C categories and protocols are handled: <ul> - <li> Class extensions are now treated as part of the class, whereas + <li> Class extensions are now treated as part of the class, whereas categories are listed separately.</li> <li> Fixed parse problem where category had a { } section.</li> <li> Fixed parse problem for categories that implemented protocols.</li> <li> Fixed render bug for protocols in class diagrams.</li> <li> Attributes with the same name as a method are now no longer matched.</li> <li> Internal properties are now also marked with [implementation]</li> - <li> Members of categories are shown in the class they extend as well, and + <li> Members of categories are shown in the class they extend as well, and cross reference links are made between these members.</li> <li> Class extension implementing protocols are now shown as protocols inherited by the class itself, including the "Implemented by" relation.</li> @@ -2825,25 +2995,25 @@ href="https://github.com/doxygen/doxygen/commit/a697caadf1912d0d74faa208f4cff887 stylesheet without completely replacing doxygen.css.</li> <li> Added option AUTOLINK_SUPPORT which can be used to enable/disable autolinking globally.</li> -<li> Included language updates for Czech, Spanish, Greek, Slovak, and +<li> Included language updates for Czech, Spanish, Greek, Slovak, and Esperanto.</li> </ul> <h3>Bug fixes</h3> <ul> <li> Fixed render glitch where template member of a base class was not properly hidden in the derived class.</li> -<li> Privately nested classes no longer appear in the declaration section +<li> Privately nested classes no longer appear in the declaration section of their parent if EXTRACT_PRIVATE is disabled.</li> <li> In the declaration section the separator line was in between the member and its brief description.</li> <li> Fixed a couple of compiler warning with the new XCode 4.4 compiler.</li> <li> Added compilation support for Mountain Lion (Mac OS X 10.8).</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4789">4789</a>: Nested namespaces did not appear in the namespace list if the +<li> id <a href="https://github.com/doxygen/doxygen/issues/4789">4789</a>: Nested namespaces did not appear in the namespace list if the parent namespace was undocumented.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4809">4809</a>: Fixed some spelling errors in the code comments.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4814">4814</a>: Fortran: comma at begin of argument list description in +<li> id <a href="https://github.com/doxygen/doxygen/issues/4814">4814</a>: Fortran: comma at begin of argument list description in case of implicit type</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4815">4815</a>: Fortran: Entities on line with USE, ONLY were not hyperlinked +<li> id <a href="https://github.com/doxygen/doxygen/issues/4815">4815</a>: Fortran: Entities on line with USE, ONLY were not hyperlinked in code.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4816">4816</a>: Fortran: handle carriage return in non terminated strings.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4821">4821</a>: Using Markdown formatting in @todo/@bug/.. like descriptions @@ -2854,14 +3024,14 @@ href="https://github.com/doxygen/doxygen/commit/a697caadf1912d0d74faa208f4cff887 the same heading (just like \todo and friends). </li> <li> Fixed case where full directory path was shown even though FULL_PATH_NAMES was set to NO.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4825">4825</a>: HTML output of template-derived classes contained unescaped +<li> id <a href="https://github.com/doxygen/doxygen/issues/4825">4825</a>: HTML output of template-derived classes contained unescaped characters.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4800">4800</a>: "Class Index" appeared twice in the PDF TOC, Index at the +<li> id <a href="https://github.com/doxygen/doxygen/issues/4800">4800</a>: "Class Index" appeared twice in the PDF TOC, Index at the end did not appear at all.</li> -<li> In a declaration no link was created when referring to a class inside +<li> In a declaration no link was created when referring to a class inside an undocumented namespace imported via a tag file.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4840">4840</a>: Make default for TAB_SIZE 4 and added remark in Markdown - section of the manual about the effect of TAB_SIZE on code block + section of the manual about the effect of TAB_SIZE on code block processing when using tabs in the comment block.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4835">4835</a>: Project logo was not included in the Qt help output.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4834">4834</a>: Fixed a couple of typos in the comments.</li> @@ -2879,16 +3049,16 @@ href="https://github.com/doxygen/doxygen/commit/a697caadf1912d0d74faa208f4cff887 </p> <h3>Changes</h3> <ul> -<li> doxygen now strips the leading indentation shared by the lines in a +<li> doxygen now strips the leading indentation shared by the lines in a @code..@endcode block.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4755">4755</a>: Changed title of the SVG graphs from 'G' to the root node of the graph.</li> </ul> <h3>New features</h3> <ul> -<li> Added button in the navigation tree to allow enabling/disabling +<li> Added button in the navigation tree to allow enabling/disabling syncing the navigation tree with the content.</li> -<li> Extended the number of HTML entities with Greek letters and other +<li> Extended the number of HTML entities with Greek letters and other symbols (thanks to Charles Karney for the patch).</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4464">4464</a>: Added support for C++11 strongly typed enums (enum class E { ... }).</li> @@ -2902,25 +3072,25 @@ href="https://github.com/doxygen/doxygen/commit/a697caadf1912d0d74faa208f4cff887 <li> id <a href="https://github.com/doxygen/doxygen/issues/4702">4702</a>: Fixed another case where local include path did not appear correctly in the class documentation.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4716">4716</a>: Fortran: Some keyword were not colored in the source view.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4720">4720</a>: Fortran: Argument type was wrong type of in case of out of +<li> id <a href="https://github.com/doxygen/doxygen/issues/4720">4720</a>: Fortran: Argument type was wrong type of in case of out of place !> comment</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4739">4739</a>: Included patch to fix problem compiling for x86 release on Windows.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4741">4741</a>: Section without title could result in an invalid Qt Help index.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4743">4743</a>: Anonymous enum could result in an invalid Qt Help index.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4751">4751</a>: Superfluous trailing comma in javascript +<li> id <a href="https://github.com/doxygen/doxygen/issues/4751">4751</a>: Superfluous trailing comma in javascript prevented navigation tree to load in IE7.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4753">4753</a>: a + at the start of a line inside a <pre> block, - triggered the start of a list. Also -- and --- where not kept untouched +<li> id <a href="https://github.com/doxygen/doxygen/issues/4753">4753</a>: a + at the start of a line inside a <pre> block, + triggered the start of a list. Also -- and --- where not kept untouched inside a <pre> block.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4754">4754</a>: ndash (--) appearing in a brief description could lead +<li> id <a href="https://github.com/doxygen/doxygen/issues/4754">4754</a>: ndash (--) appearing in a brief description could lead to invalid SVG images.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4759">4759</a>: -- and --- inside a Markdown code block were not handled properly.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4783">4783</a>, <a href="https://github.com/doxygen/doxygen/issues/4699">4699</a>: In body documentation with a different indentation then the main documentation was not rendered correctly (MARKDOWN=YES).</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4784">4784</a>: Using an escaped pipe symbol in a Markdown table did not get +<li> id <a href="https://github.com/doxygen/doxygen/issues/4784">4784</a>: Using an escaped pipe symbol in a Markdown table did not get unescaped in the output.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4785">4785</a>: Code fragments did not appear properly in the doxygen manual.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4786">4786</a>: Added missing delete call in a piece of debugging code.</li> @@ -2942,7 +3112,7 @@ href="https://github.com/doxygen/doxygen/commit/a697caadf1912d0d74faa208f4cff887 <h3>Changes</h3> <ul> <li> Integrated the root navigation tree in navtree.js for faster loading.</li> -<li> When the navigation tree is enabled, clicking jump to a line in +<li> When the navigation tree is enabled, clicking jump to a line in the source code view will now highlight the line.</li> </ul> <h3>New features</h3> @@ -2954,12 +3124,12 @@ href="https://github.com/doxygen/doxygen/commit/a697caadf1912d0d74faa208f4cff887 </ul> <h3>Bug fixes</h3> <ul> -<li> id <a href="https://github.com/doxygen/doxygen/issues/3772">3772</a>: Fortran: Appearance of comments in the HTML output +<li> id <a href="https://github.com/doxygen/doxygen/issues/3772">3772</a>: Fortran: Appearance of comments in the HTML output are now customizable via CSS again.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4655">4655</a>: <code> inside a <summary> or <remarks> section is now treated as @code (was already the code for C#).</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4661">4661</a>: When a comment started at indent >= 4 after a /** and - continued at the same indent without leading * after a blank line, +<li> id <a href="https://github.com/doxygen/doxygen/issues/4661">4661</a>: When a comment started at indent >= 4 after a /** and + continued at the same indent without leading * after a blank line, the continued part appeared at as a code block when Markdown was enabled.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4689">4689</a>: If a file was not indexed, the navigation tree became empty.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4702">4702</a>: Include path using quotes did not work as documented.</li> @@ -2967,27 +3137,27 @@ href="https://github.com/doxygen/doxygen/commit/a697caadf1912d0d74faa208f4cff887 a numbered list.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4713">4713</a>: An anonymous namespace could introduce an invalid entry in the navigation list.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4715">4715</a>: Breadcrumb navigation path had wrong links when +<li> id <a href="https://github.com/doxygen/doxygen/issues/4715">4715</a>: Breadcrumb navigation path had wrong links when CREATE_SUBDIRS was enabled.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4729">4729</a>: Fixed case where function was incorrectly detected as a +<li> id <a href="https://github.com/doxygen/doxygen/issues/4729">4729</a>: Fixed case where function was incorrectly detected as a variable.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4733">4733</a>: Fixed typo in the documentation of the LAYOUT_FILE option.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4737">4737</a>: Fixed visual misalignment for first argument.</li> -<li> The "arrow out" button in interactive SVG did not work when +<li> The "arrow out" button in interactive SVG did not work when served from a web server, due to the use of an absolute path.</li> -<li> If a declaration was too wide for a page, the content in HTML spilled +<li> If a declaration was too wide for a page, the content in HTML spilled over the boundary of its box, which looked ugly.</li> <li> Empty lines in a code fragment were collapsed.</li> <li> Navigation tree entries of the hierarchy appeared under class index as well.</li> <li> Grouped globals and enum values were not added to the navigation index.</li> <li> Inlined class were not properly shows in the navigation index.</li> -<li> Documented class in undocumented namespace did not show up in +<li> Documented class in undocumented namespace did not show up in class list and navigation tree.</li> <li> ALLEXTERNALS=YES did not show all external classes in the class list.</li> <li> External reference via URL did not work for new "Additional Inherited Members" section + inherited from class link.</li> -<li> Objective-C protocols and C# generics were not index and listed +<li> Objective-C protocols and C# generics were not index and listed properly in the navigation tree and indices.</li> <li> Undocumented files could produce a broken link in the navigation tree.</li> <li> Additional Inherited Members could turn up empty of all members of @@ -3005,17 +3175,17 @@ href="https://github.com/doxygen/doxygen/commit/a697caadf1912d0d74faa208f4cff887 <li> Changed the way indexes (Class,File,Namespace,Groups) are rendered: <p> There are now shown in a uniform way in the HTML output as a tree. - Trees can be expanded and collapsed interactively - (this makes USE_INLINE_TREES obsolete). + Trees can be expanded and collapsed interactively + (this makes USE_INLINE_TREES obsolete). </p><p> - The class list now also shows namespaces and nested classes. - The file list now also shows directories (this makes SHOW_DIRECTORIES - obsolete). + The class list now also shows namespaces and nested classes. + The file list now also shows directories (this makes SHOW_DIRECTORIES + obsolete). </p><p> Member sections are now each rendered in a separate table. This makes the HTML_ALIGN_MEMBERS option obsolete. </p><p> -<b>Note:</b> If you use a custom header for the HTML output (HTML_HEADER) +<b>Note:</b> If you use a custom header for the HTML output (HTML_HEADER) make sure you add the following: </p> <pre> @@ -3027,14 +3197,14 @@ make sure you add the following: <li> Changed the way member attributes (like protected, virtual, and static) are rendered in the HTML output.</li> <li> Changed the look of the source code output.</li> -<li> Included language updates for Chinese, Czech, German, Esperanto, +<li> Included language updates for Chinese, Czech, German, Esperanto, Italian, Slovak, Spanish, Hungarian, and Polish.</li> <li> Syntax highlighting in source code fragments is no longer dependent on LATEX_SOURCE_CODE being set to YES.</li> -<li> Added natural scrolling for tablet devices (like the iPad) +<li> Added natural scrolling for tablet devices (like the iPad) when using the treeview.</li> -<li> For interactive SVGs the print button has been replaced by a - "arrow out" button that opens the original non-interactive SVG in a +<li> For interactive SVGs the print button has been replaced by a + "arrow out" button that opens the original non-interactive SVG in a new window for easy printing or saving. </li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4426">4426</a>: Long names are now wrapped in the dot nodes to avoid very wide graphs.</li> @@ -3061,17 +3231,17 @@ make sure you add the following: <li> id <a href="https://github.com/doxygen/doxygen/issues/4502">4502</a>: Include VHDL patch (thanks to Martin Kreis).</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4569">4569</a>: Fixed include guard detection problem when using #pragma once</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4582">4582</a>: A numbered list (1. 2. 3.) where each list item ended with - an empty line is no longer treated as a set of separate lists (all +<li> id <a href="https://github.com/doxygen/doxygen/issues/4582">4582</a>: A numbered list (1. 2. 3.) where each list item ended with + an empty line is no longer treated as a set of separate lists (all starting with 1.).</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4586">4586</a>: Java: last enum value did not appear in the output unless it was followed by a comma.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4591">4591</a>, <a href="https://github.com/doxygen/doxygen/issues/4606">4606</a>: Regression: Autolist items starting on a new paragraph +<li> id <a href="https://github.com/doxygen/doxygen/issues/4591">4591</a>, <a href="https://github.com/doxygen/doxygen/issues/4606">4606</a>: Regression: Autolist items starting on a new paragraph at indent level larger than 0 were not processed correctly. </li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4594">4594</a>: Sections could be missing from the navigation tree in +<li> id <a href="https://github.com/doxygen/doxygen/issues/4594">4594</a>: Sections could be missing from the navigation tree in some situations.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4597">4597</a>: @tableofcontents did not work for the main page (@mainpage)</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4598">4598</a>: Sections in a separate markdown page did not appear in the +<li> id <a href="https://github.com/doxygen/doxygen/issues/4598">4598</a>: Sections in a separate markdown page did not appear in the table of contents.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4600">4600</a>: Fortran: Fixed problem causing call/caller graphs not to be generated.</li> @@ -3089,7 +3259,7 @@ make sure you add the following: <li> id <a href="https://github.com/doxygen/doxygen/issues/4610">4610</a>: docset creating could fail due to invalid Nodes.xml</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4614">4614</a>: Using \internal in a group or member did not hide it from the navigation tree if there was no documentation.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4615">4615</a>: Backticks in C# comments did not appear as inline +<li> id <a href="https://github.com/doxygen/doxygen/issues/4615">4615</a>: Backticks in C# comments did not appear as inline fragments, like was the case for other languages.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4620">4620</a>: PHP: defines are now shown as constants rather than enums.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4636">4636</a>: File with .md or .markdown extension were not included @@ -3104,9 +3274,9 @@ make sure you add the following: <li> id <a href="https://github.com/doxygen/doxygen/issues/"></a>: PHP: use keyword was not handled correctly when importing classes from another namespace.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4634">4634</a>: Switched to using "Macro" in the output instead of "Define".</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4635">4635</a>: Using  did not work correctly for +<li> id <a href="https://github.com/doxygen/doxygen/issues/4635">4635</a>: Using  did not work correctly for local images pointed to with IMAGE_PATH.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4642">4642</a>: A block of ///'s inside a verbatim block inside a .md +<li> id <a href="https://github.com/doxygen/doxygen/issues/4642">4642</a>: A block of ///'s inside a verbatim block inside a .md file was replaced by /** .. */</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4645">4645</a>: Doxygen now skips scanning files in directories starting with a dot (e.g. .svn).</li> @@ -3115,7 +3285,7 @@ make sure you add the following: <li> id <a href="https://github.com/doxygen/doxygen/issues/4659">4659</a>: Added C++11 classes when BUILTIN_STL_SUPPORT is enabled.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4662">4662</a>: Using a backslash in a section causes 026E30F to appear in the LaTeX TOC.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4675">4675</a>: Fortran: case sensitiveness for routines and functions +<li> id <a href="https://github.com/doxygen/doxygen/issues/4675">4675</a>: Fortran: case sensitiveness for routines and functions did not work</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4676">4676</a>: Fortran: continuation by ampersand not placed in code output.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4698">4698</a>: Fixed indenting issue after the end of a markdown code block @@ -3154,10 +3324,10 @@ make sure you add the following: <li> Updated the manual and improved the look.</li> <li> Made the contents in the navigation tree more consistent for groups, pages with subpages, and grouped subpages.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4558">4558</a>: Latex: made the margins of latex page layout smaller using +<li> id <a href="https://github.com/doxygen/doxygen/issues/4558">4558</a>: Latex: made the margins of latex page layout smaller using the geometry package.</li> <li> The tool doxytag has been declared obsolete and is removed - (it wasn't working properly anyway). Same goes for the installdox + (it wasn't working properly anyway). Same goes for the installdox script.</li> <li> Updated the copyright in source code and doxywizard "about" to 2012.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4533">4533</a>: HTML version of the manual now has the treeview enabled @@ -3165,11 +3335,11 @@ make sure you add the following: </ul> <h3>New features</h3> <ul> -<li> Added support for +<li> Added support for <a href="https://daringfireball.net/projects/markdown/">Markdown</a> formatting. - This is enabled by default, but can be disabled by - setting MARKDOWN_SUPPORT to NO. When enabled the following is + This is enabled by default, but can be disabled by + setting MARKDOWN_SUPPORT to NO. When enabled the following is processed differently: <ul> <li> tabs are converted to spaces according to TAB_SIZE.</li> @@ -3199,11 +3369,11 @@ make sure you add the following: the navigation menu using the layout file (see the section of the manual about customizing the output for details).</li> <li> Added new command \tableofcontents (or [TOC] if you prefer Markdown) - which can be used in a related page with sections to produce a + which can be used in a related page with sections to produce a table of contents at the top of the HTML page (for other formats the command has no effect).</li> <li> When using SVG images and INTERACTIVE_SVG is enabled, a print icon - will be visible along with the navigation controls to facilitate + will be visible along with the navigation controls to facilitate printing of the part of the graph that is visible on screen.</li> <li> Added obfuscation of email addresses for the HTML output to make email harvesting more difficult.</li> @@ -3227,10 +3397,10 @@ make sure you add the following: <h3>Bug fixes</h3> <ul> <li> id <a href="https://github.com/doxygen/doxygen/issues/2729">2729</a>: Fixed encoding issue in CHM index file for group titles.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/2791">2791</a>: FORTRAN: Keywords like .GT. recognized as symbols for +<li> id <a href="https://github.com/doxygen/doxygen/issues/2791">2791</a>: FORTRAN: Keywords like .GT. recognized as symbols for cross ref.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/2799">2799</a>, <a href="https://github.com/doxygen/doxygen/issues/3376">3376</a>, <a href="https://github.com/doxygen/doxygen/issues/3825">3825</a>: \copydoc did copy the brief description - into the detailed section, causing a difference between the original + into the detailed section, causing a difference between the original and the copy.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3116">3116</a>: Using @ref for an example file, caused it to appear as file::ext.</li> @@ -3247,11 +3417,11 @@ make sure you add the following: form A<func(T*)> such as used in boost::signal2 types.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4500">4500</a>: A </p> followed by an htmlonly..endhtmlonly section caused invalid XHTML output.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4501">4501</a>: Fixed include handling in case the include guard was +<li> id <a href="https://github.com/doxygen/doxygen/issues/4501">4501</a>: Fixed include handling in case the include guard was documented.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4505">4505</a>: Fixed problem loading the navigation tree in IE8 when serving pages via a web server.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4506">4506</a>: Included patch to avoid hyphenation hints in front of the +<li> id <a href="https://github.com/doxygen/doxygen/issues/4506">4506</a>: Included patch to avoid hyphenation hints in front of the first capital in a word.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4509">4509</a>: When SHOW_FILES was NO, a grouped function did not appear in the javascript based search index.</li> @@ -3261,10 +3431,10 @@ make sure you add the following: <li> id <a href="https://github.com/doxygen/doxygen/issues/4516">4516</a>: Fixed bug in the generated makefile causing index not to be generated when using pdflatex.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4517">4517</a>: HTML output for example pages was not well-formed.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4520">4520</a>: Include statements in latex output where placed all on +<li> id <a href="https://github.com/doxygen/doxygen/issues/4520">4520</a>: Include statements in latex output where placed all on one line in the LaTeX output.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4526">4526</a>: PHP: Fixed problem handling heredoc blocks</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4527">4527</a>: For aliases with a single argument it is no longer required +<li> id <a href="https://github.com/doxygen/doxygen/issues/4527">4527</a>: For aliases with a single argument it is no longer required to escape commas that appear inside the argument text.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4536">4536</a>: Latex: tables can now span multiple pages by using the xtab package.</li> @@ -3276,7 +3446,7 @@ make sure you add the following: with a namespaced type was used.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4557">4557</a>: Included patch which changes MATHJAX_RELPATH to use the content delivery network by default.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4560">4560</a>: Fortran: Fixed problem handling multiple definition +<li> id <a href="https://github.com/doxygen/doxygen/issues/4560">4560</a>: Fortran: Fixed problem handling multiple definition statements on one line.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4561">4561</a>: Using -d Preprocessor now also works when QUIET is YES.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4563">4563</a>: Latex: citations where only generated properly if the @@ -3287,7 +3457,7 @@ make sure you add the following: <li> id <a href="https://github.com/doxygen/doxygen/issues/4580">4580</a>: subpages generate empty pages in latex/rtf output and broken links when SHORT_NAME was set to YES.</li> <li> Included VHDL fixes provided by Martin Kreis.</li> -<li> The word "dummy" wrongly appeared before the first parameter type in +<li> The word "dummy" wrongly appeared before the first parameter type in the LaTeX output for an Objective-C method.</li> <li> Fixed several small glitches in the tree view javascript code.</li> <li> Included a patch by Vladimir Simonov to make it possible to compile @@ -3304,9 +3474,9 @@ make sure you add the following: <b>(release date 10-12-2011)</b> <h3>Changes</h3> <ul> -<li> Doxygen now reports its cache usage (for the symbol and the - lookup cache) at the end of a run (if QUIET=NO), and recommends - settings for SYMBOL_CACHE_SIZE and LOOKUP_CACHE_SIZE for your +<li> Doxygen now reports its cache usage (for the symbol and the + lookup cache) at the end of a run (if QUIET=NO), and recommends + settings for SYMBOL_CACHE_SIZE and LOOKUP_CACHE_SIZE for your project if either cache is too small.</li> </ul> <h3>New features</h3> @@ -3323,9 +3493,9 @@ make sure you add the following: <li> id <a href="https://github.com/doxygen/doxygen/issues/4490">4490</a>: Fixed XHTML validity problem when using mscgen graphs.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4493">4493</a>: Fixed XHTML validity problem when GENERATE_TREEVIEW was disabled.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4494">4494</a>: Included patch to fix hang issue when non-empty +<li> id <a href="https://github.com/doxygen/doxygen/issues/4494">4494</a>: Included patch to fix hang issue when non-empty INCLUDE_PATH was used.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4495">4495</a>: Fixed parse issue when a comma appeared as part of an +<li> id <a href="https://github.com/doxygen/doxygen/issues/4495">4495</a>: Fixed parse issue when a comma appeared as part of an enum's value.</li> </ul> <a name="1.7.6"></a> @@ -3344,7 +3514,7 @@ make sure you add the following: the navigation tree.</li> <li> Improved HTML output support for IE9.</li> <li> Included redesigned VHDL parser (thanks to Martin Kreis for the patch)</li> -<li> When a class/structs has many (>15) members of the same type, only +<li> When a class/structs has many (>15) members of the same type, only the first 10 are shown in the UML diagram. </li> <li> Made the output of the javascript based search engine more compact.</li> </ul> @@ -3353,34 +3523,34 @@ make sure you add the following: <li> Update of the French translation.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3637">3637</a>: Added support for PHP heredoc and nowdoc constructs.</li> <li> Added support for cross-referencing in case of operator-> overloading. - This includes support for std::auto_ptr,std::smart_ptr,std::unique_ptr + This includes support for std::auto_ptr,std::smart_ptr,std::unique_ptr and std::weak_ptr when BUILTIN_STL_SUPPORT is enabled.</li> </ul> <h3>Bug fixes</h3> <ul> -<li> Regression: some information was no longer available for a class, +<li> Regression: some information was no longer available for a class, due to accidental deletion of a code block.</li> <li> Regression: fixed matching problem in the code parser.</li> -<li> Included fixes for TCL to support commands with \ and command +<li> Included fixes for TCL to support commands with \ and command definitions preceded by whitespace (thanks to Rene Zaumseil)</li> -<li> When using "static int a,b" variable "b" incorrectly appeared in the +<li> When using "static int a,b" variable "b" incorrectly appeared in the output even though EXTRACT_STATIC was set to NO.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/2867">2867</a>: .spec file was only updated after running ./configure</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4363">4363</a>: Fixed potential crash when using doxygen for large projects.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4370">4370</a>: Fixed problem running bibtex with \cite command on Windows.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4375">4375</a>: Fixed constant expression evaluation error in the +<li> id <a href="https://github.com/doxygen/doxygen/issues/4375">4375</a>: Fixed constant expression evaluation error in the preprocessor.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4294">4294</a>: Removed bogus ' from the man page output.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4411">4411</a>: Quotes in the brief description could appear unescaped in +<li> id <a href="https://github.com/doxygen/doxygen/issues/4411">4411</a>: Quotes in the brief description could appear unescaped in the tooltip.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4137">4137</a>: #includes with ../ were not always processed correctly.</li> -<li> Fixed potential crash when INLINE_GROUPED_CLASSES and INLINE_SIMPLE_STRUCTS +<li> Fixed potential crash when INLINE_GROUPED_CLASSES and INLINE_SIMPLE_STRUCTS are set to YES.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4406">4406</a>: Fixed preprocessor problem handling #defines whose value was a constant string containing ///.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4419">4419</a>: Using a \ at the end of a comment line could cause +<li> id <a href="https://github.com/doxygen/doxygen/issues/4419">4419</a>: Using a \ at the end of a comment line could cause parsing problems for C# as the \ was treated as a line continuation.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4391">4391</a>: Fixed parser problem when using multiple member groups +<li> id <a href="https://github.com/doxygen/doxygen/issues/4391">4391</a>: Fixed parser problem when using multiple member groups inside a macro definition.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/2755">2755</a>: Fixed several issues related to \cite handling.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4400">4400</a>: Improved the way macro definitions are collected.</li> @@ -3397,21 +3567,21 @@ make sure you add the following: ClassName's wasn't autolinked.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4437">4437</a>: Fixed potential printing of null pointer when using a version filter that returned blanks.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/3871">3871</a>: Fortran: first problem where subroutine using results +<li> id <a href="https://github.com/doxygen/doxygen/issues/3871">3871</a>: Fortran: first problem where subroutine using results variable appeared as a function.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4331">4331</a>: If an URL appeared at the end of a sentence, the period was included in the URL.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4362">4362</a>: Fortran: Added support for the Double Complex type.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4462">4462</a>: Included workaround for Solaris CC issue in index.cpp</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4441">4441</a>: Included patch to fix some TCL issues and add the TCL_SUBST +<li> id <a href="https://github.com/doxygen/doxygen/issues/4441">4441</a>: Included patch to fix some TCL issues and add the TCL_SUBST configuration option.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4428">4428</a>: Fortran: Added support for ALIAS expansion in comment blocks.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4451">4451</a>: Fixed case where a macro was not corrected found in the header file when it could only be found via INCLUDE_PATH.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4474">4474</a>: using multiple <para>'s inside a <summary> block caused +<li> id <a href="https://github.com/doxygen/doxygen/issues/4474">4474</a>: using multiple <para>'s inside a <summary> block caused text to be joined without spacing.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4361">4361</a>: Java enums are now parsed as classes. </li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4477">4477</a>: Fixed problem in the preprocessor regarding the handling +<li> id <a href="https://github.com/doxygen/doxygen/issues/4477">4477</a>: Fixed problem in the preprocessor regarding the handling of include guards.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4478">4478</a>: Fixed typo in the docs for EXCLUDE_SYMLINKS.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4487">4487</a>: Using a relative URL with <a href> did not work when @@ -3431,7 +3601,7 @@ make sure you add the following: <li> id <a href="https://github.com/doxygen/doxygen/issues/2867">2867</a>: .spec file was only updated after running ./configure</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4363">4363</a>: Fixed potential crash when using doxygen for large projects.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4370">4370</a>: Fixed problem running bibtex with \cite command on Windows.</li> -<li>Regression: some information was no longer available for a class, +<li>Regression: some information was no longer available for a class, due to accidental deletion of a code block.</li> <li>Regression: fixed matching problem in the code parser.</li> </ul> @@ -3440,7 +3610,7 @@ make sure you add the following: <b>(release date 14-08-2011)</b> <h3>Changes</h3> <ul> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4145">4145</a>: Function in the call graphs are now shown based on first +<li> id <a href="https://github.com/doxygen/doxygen/issues/4145">4145</a>: Function in the call graphs are now shown based on first appearance rather then alphabetical order.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3743">3743</a>: When customizing the HTML header $title now only generates the title excluding the project name (which can still be added using @@ -3451,40 +3621,40 @@ make sure you add the following: <ul> <li> New option INTERACTIVE_SVG which when set to YES in combination with DOT_IMAGE_FORMAT=svg will make doxygen - generate interactive SVG diagrams that support zooming and + generate interactive SVG diagrams that support zooming and panning via the mouse (only for large graphs). </li> -<li> Added support for the Tcl programming language +<li> Added support for the Tcl programming language (thanks to Rene Zaumseil and Samuel Bentley for the patch).</li> <li> Added @copyright command.</li> <li> added option MATHJAX_EXTENSIONS to provide additional extensions for MathJax (thanks to David Munger for the patch).</li> <li> added option INLINE_SIMPLE_STRUCTS which when enabled shows the fields of simple classes and structs (with only public data fields) as a table - and inline in context (file/group/namespace/class) provided this context + and inline in context (file/group/namespace/class) provided this context is documented.</li> <li> When using the server based search engine (SEARCHENGINE=YES and SERVER_BASED_SEARCH=YES) doxygen now advertises a opensearch provider for your project, that allows integrating the search directly in the search field of the browser (thanks to Phil Lello for the patch).</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/2755">2755</a>: Added new option CITE_BIB_FILES and LATEX_BIB_STYLE and a new - command \cite, allowing you to make references to literature (as defined - in one or more .bib files). This also works for output formats other +<li> id <a href="https://github.com/doxygen/doxygen/issues/2755">2755</a>: Added new option CITE_BIB_FILES and LATEX_BIB_STYLE and a new + command \cite, allowing you to make references to literature (as defined + in one or more .bib files). This also works for output formats other than LaTeX. The tool bibtex is required for this to work though. Thanks to David Munger for the initial patch upon which this feature is based.</li> <li> PHP namespaces are now shown as A\B in the output.</li> -<li> Added new \snippet command that can be used to include marked - sections from a source file. See +<li> Added new \snippet command that can be used to include marked + sections from a source file. See <a href="commands.html#cmdsnippet">\snippet</a> for more info.</li> <li> Added translation support for Armenian, thank to Armen Tangamyan. and included translation updates for a number of languages.</li> </ul> <h3>Bug fixes</h3> <ul> -<li> Fixed a couple of potential race conditions found by Helgrind while +<li> Fixed a couple of potential race conditions found by Helgrind while running dot from multiple threads.</li> -<li> Graphs did not appear when enabling both INTERACTIVE_SVG and +<li> Graphs did not appear when enabling both INTERACTIVE_SVG and HTML_DYNAMIC_SECTIONS.</li> -<li> PDFs generated by newer versions of dot (i.e. 2.28) did not appear +<li> PDFs generated by newer versions of dot (i.e. 2.28) did not appear in the output, because doxygen failed to extract the bounding box.</li> <li> Improved call graph and cross-reference support for Python.</li> <li> INTERACTIVE_SVG now also works with IE9 if the html file extension is @@ -3497,7 +3667,7 @@ make sure you add the following: depending on the code page (thanks to Hirao for the patch).</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/2867">2867</a>: The .spec file in the source distribution did not get updated to the latest version.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/2872">2872</a>: Fortran: Continuation character was not recognized in +<li> id <a href="https://github.com/doxygen/doxygen/issues/2872">2872</a>: Fortran: Continuation character was not recognized in fixed format code.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/2887">2887</a>: Fortran: @param checking was not case insensitive.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3168">3168</a>: Fixed problem combining @cond with preprocessor directives.</li> @@ -3510,13 +3680,13 @@ make sure you add the following: class to appear with a -g postfix in C# </li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3883">3883</a>: Fortran: Fixed issue handling private subroutines.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3990">3990</a>: LaTeX now starts a new page when starting a new module.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4014">4014</a>: Fortran: Prefix of function was overwritten and the word +<li> id <a href="https://github.com/doxygen/doxygen/issues/4014">4014</a>: Fortran: Prefix of function was overwritten and the word 'function' not specified.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4050">4050</a>: Fortran: Included fix for using collaboration diagrams.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4158">4158</a>: Added PHP support for namespace with curly braces.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4174">4174</a>: Fortran: Improved handling of semicolons.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4178">4178</a>: Fortran: Added support for "type is".</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4188">4188</a>: A macro added to a group appeared twice in the group +<li> id <a href="https://github.com/doxygen/doxygen/issues/4188">4188</a>: A macro added to a group appeared twice in the group documentation if was also made related to a class using \relates.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4221">4221</a>: Fixed problem were the search box was missing when using a custom HTML header.</li> @@ -3527,9 +3697,9 @@ make sure you add the following: the code.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4230">4230</a>, <a href="https://github.com/doxygen/doxygen/issues/4231">4231</a>: Putting an autolist inside a @todo, @bug or similar section did not work anymore.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4232">4232</a>: Referring to a logo with a relative path, caused +<li> id <a href="https://github.com/doxygen/doxygen/issues/4232">4232</a>: Referring to a logo with a relative path, caused a broken image target when using a custom HTML header.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4235">4235</a>: Fixed HTML rendering problem on older browsers when +<li> id <a href="https://github.com/doxygen/doxygen/issues/4235">4235</a>: Fixed HTML rendering problem on older browsers when GENERATE_TREEVIEW was enabled.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4242">4242</a>: Linking to a section on the main page could result in a broken link when GENERATE_TREEVIEW was enabled.</li> @@ -3549,29 +3719,29 @@ make sure you add the following: GENERATE_TREEVIEW option is set to YES.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4281">4281</a>: Fixed broken link to an undocumented namespace.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4291">4291</a>: Fixed potential crash while parsing Fortran code.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4292">4292</a>: Fixed problem parsing comment which included +<li> id <a href="https://github.com/doxygen/doxygen/issues/4292">4292</a>: Fixed problem parsing comment which included an unterminated alias within quotes (i.e. "\word{")</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4294">4294</a>: Lines starting with . did not appear in the man page output.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4296">4296</a>: Fortran: Fixed text is detailed function section.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4297">4297</a>: When enabling INTERACTIVE_SVG wide graphs are now also fit to the screen width.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4304">4304</a>: Added missing space between parameter type and name in +<li> id <a href="https://github.com/doxygen/doxygen/issues/4304">4304</a>: Added missing space between parameter type and name in the RTF output.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4305">4305</a>: Use background-color instead of background in doxygen.css.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4313">4313</a>: Fixed potential segfault while creating man pages.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4321">4321</a>: Fortran: add a space to "type" in argument list.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4324">4324</a>: Fixed problem handling include guard when multiple +<li> id <a href="https://github.com/doxygen/doxygen/issues/4324">4324</a>: Fixed problem handling include guard when multiple blocks guarded by the same guard were used in a header file. </li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4327">4327</a>: Fortran: Unified handling of @params at various places.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/"></a>: make clean failed on a system without qmake.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4332">4332</a>: Fixed compile issue for HP Itanium.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4339">4339</a>: Fortran: Interface was seen as a class with constructor / +<li> id <a href="https://github.com/doxygen/doxygen/issues/4339">4339</a>: Fortran: Interface was seen as a class with constructor / destructor.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4341">4341</a>: Using the word "property" as a type in C caused wrong +<li> id <a href="https://github.com/doxygen/doxygen/issues/4341">4341</a>: Using the word "property" as a type in C caused wrong results.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4340">4340</a>: Fortran: fixed issue parsing function type that looked like C function pointers.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4345">4345</a>: Fortran: Fixed parse issue when using variable name +<li> id <a href="https://github.com/doxygen/doxygen/issues/4345">4345</a>: Fortran: Fixed parse issue when using variable name starting with the word interface.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4348">4348</a>: Improved error handling for empty html style list.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4352">4352</a>: Fixed case where %s could end up in a warning message.</li> @@ -3595,13 +3765,13 @@ make sure you add the following: <li> Included updates for the Italian and Russian translation.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4121">4121</a>: Added option HTML_EXTRA_FILES which makes it easier to copy additional files to the HTML output and also add them to the index files.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4162">4162</a>: Included patch that adds new LATEX_FOOTER option to +<li> id <a href="https://github.com/doxygen/doxygen/issues/4162">4162</a>: Included patch that adds new LATEX_FOOTER option to customize the end of refman.tex in the LaTeX output.</li> </ul> <h3>Bug fixes</h3> <ul> <li> id <a href="https://github.com/doxygen/doxygen/issues/1067">1067</a>: Jumping to a @section did not work in the RTF output.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/2868">2868</a>: Fortran: included patch for supporting multiple argument +<li> id <a href="https://github.com/doxygen/doxygen/issues/2868">2868</a>: Fortran: included patch for supporting multiple argument declarations on one line.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/2872">2872</a>: Fixed problem with line continuation in Fortran.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3217">3217</a>: %A::B now prevents a link for A::B, instead of only for A @@ -3631,18 +3801,18 @@ make sure you add the following: given to the QHP_CUST_FILTER_ATTRS option.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4112">4112</a>: Long error messages could cause memory corruption.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4116">4116</a>: XML: switched indent option to no in the combine.xslt script.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4117">4117</a>: Comment with XML style list of type table was not rendered +<li> id <a href="https://github.com/doxygen/doxygen/issues/4117">4117</a>: Comment with XML style list of type table was not rendered properly.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4118">4118</a>: Added support for overloading of C# indexer operators.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4119">4119</a>: Internal section marked with @internal was not shown as such anymore in the XML output.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4120">4120</a>: PHP: Fixed parse problem referring to class in global +<li> id <a href="https://github.com/doxygen/doxygen/issues/4120">4120</a>: PHP: Fixed parse problem referring to class in global namespace.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4124">4124</a>: Included patch by Haffmans to make the custom header and footer independent of the chosen config options.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4127">4127</a>: Included fix to prevent a warning in the server side PHP search script.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4128">4128</a>: Included patch to fix broken hyperlink to page entry +<li> id <a href="https://github.com/doxygen/doxygen/issues/4128">4128</a>: Included patch to fix broken hyperlink to page entry in xreflists.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4136">4136</a>: Header of \page was wrong in Man page output.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4137">4137</a>: #include to other directories were not always linked.</li> @@ -3653,16 +3823,16 @@ make sure you add the following: <li> id <a href="https://github.com/doxygen/doxygen/issues/4169">4169</a>: Fixed problem with macro expansion.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4176">4176</a>: Fixed potential crash when generating a warning for void f(int %x) style parameter, which is valid in C++/CLI.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4177">4177</a>: Included patch to enabled LargeAddressAware for Windows +<li> id <a href="https://github.com/doxygen/doxygen/issues/4177">4177</a>: Included patch to enabled LargeAddressAware for Windows builds.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4175">4175</a>: Fixed cases where FILE_VERSION_FILTER was called for +<li> id <a href="https://github.com/doxygen/doxygen/issues/4175">4175</a>: Fixed cases where FILE_VERSION_FILTER was called for dummy files with name "generated".</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4180">4180</a>: Fixed argument matching issue when one of match candidates was a typedef of a method pointer.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4210">4210</a>: mscfile tag was closed with dotfile in the XML output.</li> <li> doxygen -w html now ignores the values for HTML_HEADER and HTML_FOOTER found in the config file.</li> -<li> Importing a group via a tag file could overrule a local group with +<li> Importing a group via a tag file could overrule a local group with the same name even when EXTERNAL_GROUPS was disabled.</li> </ul> <a name="1.7.3"></a> @@ -3670,7 +3840,7 @@ make sure you add the following: <b>(release date 03-01-2011)</b> <h3>Changes</h3> <ul> -<li> Added a header for each HTML page above the navigation menu, +<li> Added a header for each HTML page above the navigation menu, showing the project name and logo and a short description (all optional). Disabling the index (with DISABLE_INDEX) still shows the new header (you can still customize this using HTML_HEADER). This now works @@ -3686,11 +3856,11 @@ make sure you add the following: </ul> <h3>New features</h3> <ul> -<li> id <a href="https://github.com/doxygen/doxygen/issues/2734">2734</a>: Added SVG support to doxygen's dot output +<li> id <a href="https://github.com/doxygen/doxygen/issues/2734">2734</a>: Added SVG support to doxygen's dot output (setting DOT_IMAGE_FORMAT to svg now works as expected)</li> <li> Added control to the wizard to configure the color of the output visually.</li> -<li> Added options to specify project synopsis and select a +<li> Added options to specify project synopsis and select a project logo to the wizard.</li> <li> Added option PROJECT_LOGO which can be used to specify an image which will be shown in the header of each HTML page along with @@ -3698,12 +3868,12 @@ make sure you add the following: <li> Added option PROJECT_BRIEF which can be used to specify a brief description which will be shown in the header of each HTML page just below the project name.</li> -<li> Added new option FILTER_SOURCE_PATTERNS which can be used - in combination with FILTER_SOURCE_FILES to filter files used for - the source browser based on file extension, which can overwrite +<li> Added new option FILTER_SOURCE_PATTERNS which can be used + in combination with FILTER_SOURCE_FILES to filter files used for + the source browser based on file extension, which can overwrite the filter set by FILTER_PATTERNS and/or INPUT_FILTER.</li> <li> Added new option STRICT_PROTO_MATCHING which is disabled by default, - and makes the parameter matching to be less strict, resulting in + and makes the parameter matching to be less strict, resulting in fewer "No matching class member found" warnings.</li> </ul> <h3>Bug fixes</h3> @@ -3714,7 +3884,7 @@ make sure you add the following: (thanks to Albert).</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3731">3731</a>: Fixed problem handling @cond..@endcond in Fortran code.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3779">3779</a>: Scope was missing in Tokens.xml when using docsets.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/3870">3870</a>, <a href="https://github.com/doxygen/doxygen/issues/2891">2891</a>: Applied patch to avoid stripping prefixes for Fortran +<li> id <a href="https://github.com/doxygen/doxygen/issues/3870">3870</a>, <a href="https://github.com/doxygen/doxygen/issues/2891">2891</a>: Applied patch to avoid stripping prefixes for Fortran subroutines.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3895">3895</a>: allow label before end statement in Fortran</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3956">3956</a>: </see> was not handled properly in comment block.</li> @@ -3736,17 +3906,17 @@ make sure you add the following: hyperlinked.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4019">4019</a>: Removed double definition of docParamName in compound.xsd.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4023">4023</a>: C++/CLI Finalizer methods were not parsed properly.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4036">4036</a>: Objective-C method names can now be used as the +<li> id <a href="https://github.com/doxygen/doxygen/issues/4036">4036</a>: Objective-C method names can now be used as the the first argument of \ref.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4037">4037</a>: Fixed a couple of problems in the compound.xsd schema used for XML output.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4038">4038</a>: DISTRIBUTE_GROUP_DOC now works again for enum values.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/4047">4047</a>: Improved matching of typedef'ed array parameter and non +<li> id <a href="https://github.com/doxygen/doxygen/issues/4047">4047</a>: Improved matching of typedef'ed array parameter and non typedef'ed array parameter.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4056">4056</a>: Added a number of fixed for Fortran interfaces.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4057">4057</a>: Handle files with the .for extension as Fortran.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4060">4060</a>: Fixed error in the grouping documentation.</li> -<li> Fixed line number sync problem when using Objective-C #import +<li> Fixed line number sync problem when using Objective-C #import statements.</li> <li> Fixed problem handling /** @cond */ in the preprocessor.</li> <li> Member groups could get reordered in the output.</li> @@ -3768,14 +3938,14 @@ make sure you add the following: <li> id <a href="https://github.com/doxygen/doxygen/issues/3855">3855</a>: Added \endinternal command that can be used to force the end of a section started with \internal.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3084">3084</a>: Added parsing support for PHP 5.3+ style namespaces.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/3389">3389</a>: added \mscfile command which can be used to insert a - message sequence chart given a .msc file. +<li> id <a href="https://github.com/doxygen/doxygen/issues/3389">3389</a>: added \mscfile command which can be used to insert a + message sequence chart given a .msc file. Also added a new config option MSCFILE_DIRS to provide directories were msc files are searched (Thanks to Adrien for the patch).</li> <li> Added support for type specifiers for documenting PHP parameters, format: "@param type $paramname docs"</li> -<li> Added support for rendering formulas in the HTML output - using MathJax instead of using prerendered bitmaps. +<li> Added support for rendering formulas in the HTML output + using MathJax instead of using prerendered bitmaps. For this purpose the options USE_MATHJAX and MATHJAX_RELPATH were added.</li> </ul> @@ -3795,7 +3965,7 @@ make sure you add the following: <li> id <a href="https://github.com/doxygen/doxygen/issues/3824">3824</a>: Undefined function macros could cause constant expression errors.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3826">3826</a>: updated copyright statement in PDF docs.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/3827">3827</a>: C# generics appeared with -g extension in the output in +<li> id <a href="https://github.com/doxygen/doxygen/issues/3827">3827</a>: C# generics appeared with -g extension in the output in some situations.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3829">3829</a>: Fixed parsing problem for "int &foo1(),&foo2();"</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3830">3830</a>: Link to destructor was wrong in the member index.</li> @@ -3811,10 +3981,10 @@ make sure you add the following: was in an undocumented namespace.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3843">3843</a>: Fixed a couple of typos in lodepng.h</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3848">3848</a>: Graph legend image was missing form the index files.</li> -<li> Fixed a number of typos in the config file documentation +<li> Fixed a number of typos in the config file documentation (thanks to Jens Schweikhardt)</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3854">3854</a>: Some enums were not cross-referenced.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/3857">3857</a>: Missing \endcond could cause preprocessor issues in +<li> id <a href="https://github.com/doxygen/doxygen/issues/3857">3857</a>: Missing \endcond could cause preprocessor issues in next file(s) to be parsed.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3862">3862</a>: a function definition in a namespace, documented in the header did not always get cross-referenced.</li> @@ -3830,8 +4000,8 @@ make sure you add the following: doxygen incorrectly ended the brief description with a dot.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3886">3886</a>: setting MULTILINE_CPP_IS_BRIEF to YES, cause /// to appear in the output.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/3890">3890</a>, <a href="https://github.com/doxygen/doxygen/issues/3235">3235</a>: EXTENSION_MAPPING did not work if a mapped - language was handled by the same parser as used for the original +<li> id <a href="https://github.com/doxygen/doxygen/issues/3890">3890</a>, <a href="https://github.com/doxygen/doxygen/issues/3235">3235</a>: EXTENSION_MAPPING did not work if a mapped + language was handled by the same parser as used for the original extension.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3894">3894</a>: Fixed bracket bug in LaTeX fancy headers.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3896">3896</a>: Allow hyphen in key argument of \xrefitem.</li> @@ -3850,11 +4020,11 @@ make sure you add the following: <li> id <a href="https://github.com/doxygen/doxygen/issues/3937">3937</a>: Latex makefile clean target used rm command also for Windows.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3939">3939</a>: the EXCLUDE_SYMBOLS option was missing form the online docs.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3962">3962</a>: \htmlinclude and \verbinclude ended the brief description.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/3963">3963</a>: Inconsistent behavior when a brief description was given +<li> id <a href="https://github.com/doxygen/doxygen/issues/3963">3963</a>: Inconsistent behavior when a brief description was given following by a detailed comment block with JAVADOC_AUTOBRIEF enabled.</li> -<li> Fixed a number of typos in the documentation +<li> Fixed a number of typos in the documentation (thanks to Albert)</li> -<li> Fixed potential hangup when scanning directories defined as +<li> Fixed potential hangup when scanning directories defined as symlinks to absolute paths.</li> <li> HTML attributes other than src were not copied for the <img> tag.</li> </ul> @@ -3863,8 +4033,8 @@ make sure you add the following: <b>(release date 25-06-2010)</b> <h3>Changes</h3> <ul> -<li> id <a href="https://github.com/doxygen/doxygen/issues/3803">3803</a>: Made warning and error messages appear with lower case - "warning:" and "error:" prefix to make it easier to use the messages +<li> id <a href="https://github.com/doxygen/doxygen/issues/3803">3803</a>: Made warning and error messages appear with lower case + "warning:" and "error:" prefix to make it easier to use the messages from Visual Studio.</li> </ul> <h3>New features</h3> @@ -3886,14 +4056,14 @@ make sure you add the following: <li> id <a href="https://github.com/doxygen/doxygen/issues/3764">3764</a>: In dot graphs now also @ref worked (previously only \ref was supported).</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3802">3802</a>: Fixed error when compiling doxygen for Solaris 8.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/3804">3804</a>: Removed bogus warning about undocumented return type for +<li> id <a href="https://github.com/doxygen/doxygen/issues/3804">3804</a>: Removed bogus warning about undocumented return type for define when WARN_NO_PARAMDOC was enabled.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/3805">3805</a>: Fixed parsing support for a function that returns a +<li> id <a href="https://github.com/doxygen/doxygen/issues/3805">3805</a>: Fixed parsing support for a function that returns a struct definition.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3806">3806</a>: Doxygen could hang when using \copydoc in a function with \param.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3807">3807</a>: Using //!< after a #define no longer worked.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/3808">3808</a>, <a href="https://github.com/doxygen/doxygen/issues/3816">3816</a>, <a href="https://github.com/doxygen/doxygen/issues/3820">3820</a>: html help compiler (and also the Qt +<li> id <a href="https://github.com/doxygen/doxygen/issues/3808">3808</a>, <a href="https://github.com/doxygen/doxygen/issues/3816">3816</a>, <a href="https://github.com/doxygen/doxygen/issues/3820">3820</a>: html help compiler (and also the Qt help compiler) was called before all dot images were generated.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3810">3810</a>: Using a auto-list in combination with \subpage cause the items to be inlined.</li> @@ -3916,18 +4086,18 @@ make sure you add the following: <h3>Changes</h3> <ul> <li> Changed the look of the HTML output.</li> -<li> Made several internal changes that should have a positive effect on the +<li> Made several internal changes that should have a positive effect on the overall performance.</li> </ul> <h3>New features</h3> <ul> -<li> The color of the HTML output can now easily be adjusted using three new - options: HTML_COLORSTYLE_HUE, HTML_COLORSTYLE_SAT, - and HTML_COLORSTYLE_GAMMA, which control respectively the hue, +<li> The color of the HTML output can now easily be adjusted using three new + options: HTML_COLORSTYLE_HUE, HTML_COLORSTYLE_SAT, + and HTML_COLORSTYLE_GAMMA, which control respectively the hue, saturation, and gamma of all elements in the HTML output.</li> <li> Moved dot invocations to the end of a doxygen run. Doxygen will now run multiple instances of dot in parallel (for better CPU utilization - on multi-core systems). The new config option DOT_NUM_THREADS + on multi-core systems). The new config option DOT_NUM_THREADS determines the number of threads used (were 0 is auto-detect).</li> <li> Added option EXT_LINKS_IN_WINDOW which controls whether or not links to symbols imported via tag files will be opened in a new window.</li> @@ -3951,25 +4121,25 @@ make sure you add the following: <li> id <a href="https://github.com/doxygen/doxygen/issues/3500">3500</a>: Links in the search results were broken if they pointed to symbols imported via tag files using an absolute path or URL.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3504">3504</a>, <a href="https://github.com/doxygen/doxygen/issues/3735">3735</a>: Fixed man page output problem when using @par.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/3506">3506</a>: A C comment before a #endif caused the preprocessor +<li> id <a href="https://github.com/doxygen/doxygen/issues/3506">3506</a>: A C comment before a #endif caused the preprocessor statement to be ignored.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3547">3547</a>: When HIDE_SCOPE_NAMES was enabled also the scope for - nested classes was stripped. Now only the namespace scope will be + nested classes was stripped. Now only the namespace scope will be stripped as before.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3575">3575</a>: Autolinks to namespace members did not work if an explicit # or :: was used.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3591">3591</a>: Slashes inside strings in java annotations were not handled properly.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/3628">3628</a>: Fixed the "show html output" button in doxywizard +<li> id <a href="https://github.com/doxygen/doxygen/issues/3628">3628</a>: Fixed the "show html output" button in doxywizard for Windows when IE was set as the default browser.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3652">3652</a>: Formatting was lost for section copied with \copydoc.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/3653">3653</a>: Fixed C++ parse issue for "class : public base {} var;" +<li> id <a href="https://github.com/doxygen/doxygen/issues/3653">3653</a>: Fixed C++ parse issue for "class : public base {} var;" construct.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3685">3685</a>: Generated HTML footer file did not have UTF-8 encoding and the relative path marker needed when using CREATE_SUBDIRS = YES.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3689">3689</a>: Fixed parsing problem with try-functions having multiple catch handlers.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/"></a>: Specialized private template member function appeared as +<li> id <a href="https://github.com/doxygen/doxygen/issues/"></a>: Specialized private template member function appeared as public.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3695">3695</a>: Include dependency graphs were sometimes wrong.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3696">3696</a>: Some lines in the generated Doxyfile where too long.</li> @@ -3990,11 +4160,11 @@ make sure you add the following: <li> id <a href="https://github.com/doxygen/doxygen/issues/3722">3722</a>: The labels of CVS tags were missing a colon.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3719">3719</a>: Fixed problem parsing Q_PROPERTY with template type and spaces.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/3729">3729</a>: Made the date string in the HTML footer translatable, +<li> id <a href="https://github.com/doxygen/doxygen/issues/3729">3729</a>: Made the date string in the HTML footer translatable, along with some other sentences on the directory pages.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/3708">3708</a>: Inline attribute was shown also for non-inline template +<li> id <a href="https://github.com/doxygen/doxygen/issues/3708">3708</a>: Inline attribute was shown also for non-inline template members.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/3733">3733</a>: Fixed problem handling @copy for operators with +<li> id <a href="https://github.com/doxygen/doxygen/issues/3733">3733</a>: Fixed problem handling @copy for operators with const qualifier.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3738">3738</a>: Fixed problem handling '"' inside comments.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3740">3740</a>: Made the LaTeX output a bit less spacious using \input.</li> @@ -4004,24 +4174,24 @@ make sure you add the following: <li> id <a href="https://github.com/doxygen/doxygen/issues/3734">3734</a>: C# namespaces are now extracted also without comment block (the language spec does not allow XML documentation).</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3742">3742</a>: included patch that fixes some typos in the code.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/3744">3744</a>, <a href="https://github.com/doxygen/doxygen/issues/3679">3679</a>: Pages with an underscore in the label generated a +<li> id <a href="https://github.com/doxygen/doxygen/issues/3744">3744</a>, <a href="https://github.com/doxygen/doxygen/issues/3679">3679</a>: Pages with an underscore in the label generated a file name containing two underscores.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3747">3747</a>: text of the form something.symbol got autolinked when symbol had a global scope.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3748">3748</a>: Call graph could be wrong when local variable has the same name as a global function.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/3750">3750</a>: Added documentation patch on how to create URL links with +<li> id <a href="https://github.com/doxygen/doxygen/issues/3750">3750</a>: Added documentation patch on how to create URL links with custom text.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/3751">3751</a>: Doxywizard now removes non-existent files from the +<li> id <a href="https://github.com/doxygen/doxygen/issues/3751">3751</a>: Doxywizard now removes non-existent files from the recent list and has an option to clear the list completely.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3752">3752</a>: A macro defined via PREDEFINED did not always overrule a macro definition in the code.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3759">3759</a>: Enabling call graphs produced invalid XHTML output.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/3766">3766</a>: Non ascii characters in file or directory names +<li> id <a href="https://github.com/doxygen/doxygen/issues/3766">3766</a>: Non ascii characters in file or directory names caused problems on Windows.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3768">3768</a>: An ALIAS with parameters spanning multiple lines caused problems with /// style comments. </li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/3775">3775</a>: Included patch to prevent image overflowing the page in +<li> id <a href="https://github.com/doxygen/doxygen/issues/3775">3775</a>: Included patch to prevent image overflowing the page in the LaTeX output.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3783">3783</a>: Fixed problem using EXTENSION_MAPPING for C# (thanks to Vsevolod Kukol for the patch).</li> @@ -4033,7 +4203,7 @@ make sure you add the following: <li> Using @include in combination with LATEX_SOURCE_CODE caused wrong output.</li> <li> Included a patch by Guido Tack which adds two new options - for docsets (DOCSET_PUBLISHER_ID and DOCSET_PUBLISHER_NAME) and + for docsets (DOCSET_PUBLISHER_ID and DOCSET_PUBLISHER_NAME) and fixes an issue with linking to docset members.</li> <li> Included patch by Stefan Oberhumer to support escaped {}'s in alias definition and parameters.</li> @@ -4049,8 +4219,8 @@ make sure you add the following: <b>(release date 21-02-2010)</b> <h3>New features</h3> <ul> -<li> id <a href="https://github.com/doxygen/doxygen/issues/3654">3654</a>: Using \dir without argument will create directory - documentation for the directory in which the \dir command +<li> id <a href="https://github.com/doxygen/doxygen/issues/3654">3654</a>: Using \dir without argument will create directory + documentation for the directory in which the \dir command was found.</li> </ul> <h3>Bug fixes</h3> @@ -4059,12 +4229,12 @@ make sure you add the following: <li> id <a href="https://github.com/doxygen/doxygen/issues/3571">3571</a>: Included patch for VHDL.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3617">3617</a>: Replaced size attribute of hr tag by class attribute in the HTML output.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/3618">3618</a>, <a href="https://github.com/doxygen/doxygen/issues/3623">3623</a>, <a href="https://github.com/doxygen/doxygen/issues/3639">3639</a>: - Using \dot produced "Error opening map file" or +<li> id <a href="https://github.com/doxygen/doxygen/issues/3618">3618</a>, <a href="https://github.com/doxygen/doxygen/issues/3623">3623</a>, <a href="https://github.com/doxygen/doxygen/issues/3639">3639</a>: + Using \dot produced "Error opening map file" or could even crash doxygen.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3619">3619</a>: Loading a new config file in doxywizard did not reset all values of a previously loaded config file.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/3621">3621</a>: Grouped members with todo-like items were shown with +<li> id <a href="https://github.com/doxygen/doxygen/issues/3621">3621</a>: Grouped members with todo-like items were shown with "GlobalScope" prefix.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3622">3622</a>: Fixed RTF rendering problem with group index.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3624">3624</a>, <a href="https://github.com/doxygen/doxygen/issues/3675">3675</a>: Added missing line break in LaTeX output.</li> @@ -4074,20 +4244,20 @@ make sure you add the following: recognised as such.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3632">3632</a>: Setting SEARCHENGINE to YES and GENERATE_HTML to NO caused error that search results directory could not be created.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/3635">3635</a>, <a href="https://github.com/doxygen/doxygen/issues/3655">3655</a>: typedef'ed enums or struct with the same as the +<li> id <a href="https://github.com/doxygen/doxygen/issues/3635">3635</a>, <a href="https://github.com/doxygen/doxygen/issues/3655">3655</a>: typedef'ed enums or struct with the same as the typedef did no longer show up.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/3636">3636</a>, <a href="https://github.com/doxygen/doxygen/issues/3643">3643</a>: Related pages (manual and automatic like the todo page) +<li> id <a href="https://github.com/doxygen/doxygen/issues/3636">3636</a>, <a href="https://github.com/doxygen/doxygen/issues/3643">3643</a>: Related pages (manual and automatic like the todo page) caused broken links when SHORT_NAMES was enabled.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/3638">3638</a>, <a href="https://github.com/doxygen/doxygen/issues/3644">3644</a>: Automatically generated related pages (like the +<li> id <a href="https://github.com/doxygen/doxygen/issues/3638">3638</a>, <a href="https://github.com/doxygen/doxygen/issues/3644">3644</a>: Automatically generated related pages (like the todo page) caused broken links when CREATE_SUBDIR was enabled.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3641">3641</a>: comments after #if could cause next function call not to be cross-referenced.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3642">3642</a>: \internal inside a conditional section caused warning.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3646">3646</a>: Using \internal inside a \section did not end at the next \section as documented.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/3647">3647</a>: \internal command produced message with .: in +<li> id <a href="https://github.com/doxygen/doxygen/issues/3647">3647</a>: \internal command produced message with .: in the LaTeX output.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/3649">3649</a>: HTML Tables with custom attributes were not rendered +<li> id <a href="https://github.com/doxygen/doxygen/issues/3649">3649</a>: HTML Tables with custom attributes were not rendered properly.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3651">3651</a>: Man pages with underscore got double underscore in the name.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3658">3658</a>: Buffer overflow when using non-ascii characters as class @@ -4101,7 +4271,7 @@ make sure you add the following: <li> id <a href="https://github.com/doxygen/doxygen/issues/3678">3678</a>: Removed bogus warning when using <br/> tag.</li> <li> Fixed parsing problem for function pointer type starting with "typedef enum".</li> -<li> Preprocessor did not take EXCLUDE_PATTERNS into account, which +<li> Preprocessor did not take EXCLUDE_PATTERNS into account, which could cause parse issues when importing a .tlb file.</li> </ul> @@ -4125,12 +4295,12 @@ make sure you add the following: This method better scales to larger projects and allows full text search.</li> <li> Added new options GENERATE_ECLIPSEHELP and ECLIPSE_DOC_ID - to generate an index file that can be used to embed doxygen's HTML - output into Eclipse as a help plugin + to generate an index file that can be used to embed doxygen's HTML + output into Eclipse as a help plugin (thanks to a patch by Ondrej Starek).</li> -<li> Wrote new <a href="searching.html">documentation</a> +<li> Wrote new <a href="searching.html">documentation</a> regarding the methods of searching in the HTML output.</li> -<li> Included patch by Ed Rosten to render formulas with +<li> Included patch by Ed Rosten to render formulas with proper anti-aliasing on non-white backgrounds using transparency.</li> <li> Add new option FORCE_LOCAL_INCLUDES to make the default #include appearance in class documentation with "" i.s.o sharp brackets.</li> @@ -4165,37 +4335,37 @@ make sure you add the following: <li> id <a href="https://github.com/doxygen/doxygen/issues/3528">3528</a>: Doxygen's preprocessor got confused when /**/ appeared as part of a macro definition.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/"></a>: Removed obsolete option USE_WINDOWS_ENCODING from the docs.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/3531">3531</a>: RTF output was missing a new paragraph for brief +<li> id <a href="https://github.com/doxygen/doxygen/issues/3531">3531</a>: RTF output was missing a new paragraph for brief member descriptions.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/3536">3536</a>, <a href="https://github.com/doxygen/doxygen/issues/3542">3542</a>: Code reformatting done for the LaTeX output could +<li> id <a href="https://github.com/doxygen/doxygen/issues/3536">3536</a>, <a href="https://github.com/doxygen/doxygen/issues/3542">3542</a>: Code reformatting done for the LaTeX output could break multibyte UTF-8 characters causing invalid output.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3537">3537</a>: Using multibyte characters in a page label caused invalid output.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/3540">3540</a>: Documented the interaction between LATEX_CMD_NAME and +<li> id <a href="https://github.com/doxygen/doxygen/issues/3540">3540</a>: Documented the interaction between LATEX_CMD_NAME and USE_PDFLATEX.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3548">3548</a>: Todo items for two inner classes with the same name where - collapsed together in the todo list when HIDE_SCOPE_NAMES + collapsed together in the todo list when HIDE_SCOPE_NAMES was enabled.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3549">3549</a>: Scope was not hidden for members in the todo list even though HIDE_SCOPE_NAMES was set to YES.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/3562">3562</a>: Struct variable with explicit struct keyword got labelled +<li> id <a href="https://github.com/doxygen/doxygen/issues/3562">3562</a>: Struct variable with explicit struct keyword got labelled with [read] attribute.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3545">3545</a>: PHP was not parsed properly when it appeared in a <script language="php"> section.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3550">3550</a>: Fixed problem matching base class member against the member in the derived class.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3551">3551</a>: Makefile for Docsets now honors DESTDIR.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/3560">3560</a>: Made browsing for HHC_LOCATION via the wizard +<li> id <a href="https://github.com/doxygen/doxygen/issues/3560">3560</a>: Made browsing for HHC_LOCATION via the wizard yield an absolute path.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3564">3564</a>: Changed default for CHM_INDEX_ENCODING to CP1250 to avoid issues in a Solaris environment.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3527">3527</a>: Removed unnecessary paragraphs from HTML table cells.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3552">3552</a>: referring to page labels of the form a-1 did not work.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3565">3565</a>: Code generators could produce extra </span> tags.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/3568">3568</a>: Included the PHP search engine again (with new config +<li> id <a href="https://github.com/doxygen/doxygen/issues/3568">3568</a>: Included the PHP search engine again (with new config option SERVER_BASED_SEARCH to enable it)</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3572">3572</a>: Doxygen produced invalid Latex output for RCS tags.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/3573">3573</a>: Fixed issue with include dependency tracking that could +<li> id <a href="https://github.com/doxygen/doxygen/issues/3573">3573</a>: Fixed issue with include dependency tracking that could cause macro expansion not to work properly.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3576">3576</a>: Fixed issue with VHDL call graph (thank to Martin Kreis for the fix).</li> @@ -4203,7 +4373,7 @@ make sure you add the following: <li> id <a href="https://github.com/doxygen/doxygen/issues/3578">3578</a>: #include inside a class could cause line numbers to be off.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3579">3579</a>: Fixed parsing problem skipping over /**/ comment.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3584">3584</a>: Fixed problem handling Javadoc style {@code ... } blocks.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/3585">3585</a>: Special commands did not work in the title of +<li> id <a href="https://github.com/doxygen/doxygen/issues/3585">3585</a>: Special commands did not work in the title of the @mainpage.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3593">3593</a>: Fixed problem parsing files that start with UTF-8 BOM.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3596">3596</a>: Fixed problem parsing friend function with explicit scope.</li> @@ -4235,17 +4405,17 @@ make sure you add the following: <b>(release date 20-08-2009)</b> <h3>Changes</h3> <ul> -<li> id <a href="https://github.com/doxygen/doxygen/issues/3372">3372</a>, <a href="https://github.com/doxygen/doxygen/issues/3012">3012</a>: Replaced the PHP based search engine by a +<li> id <a href="https://github.com/doxygen/doxygen/issues/3372">3372</a>, <a href="https://github.com/doxygen/doxygen/issues/3012">3012</a>: Replaced the PHP based search engine by a JavaScript/DHTML based one. As a result the search feature no longer requires a HTTP server with PHP enabled to be usable. Searching is limited to symbols though, but it is now possible to filter on symbol type.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/2852">2852</a>: Make the HTML output XHTML 1.0 compliant.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/3365">3365</a>: Objective-C categories are now merged with their base +<li> id <a href="https://github.com/doxygen/doxygen/issues/3365">3365</a>: Objective-C categories are now merged with their base class, unless there is no base class.</li> <li> Member groups with the same header within the same scope are now merged. This also works for Objective-C categories.</li> -<li> Changed the LaTeX style sheet such that more of the markup is +<li> Changed the LaTeX style sheet such that more of the markup is configurable. Please update your style sheet if you use a custom one.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3415">3415</a>: Treat \details inside a brief description as a new paragraph command.</li> @@ -4260,7 +4430,7 @@ make sure you add the following: constructors and destructors first in an otherwise sorted list.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3377">3377</a>: Applied patch by Tobias Hunger that adds support for documenting DBus XML interface descriptions. </li> -<li> Included QtHelp patch by Karsten Heimrich which adds missing +<li> Included QtHelp patch by Karsten Heimrich which adds missing reference and keyword for methods.</li> <li> Included updates for the Korean and Polish translation.</li> </ul> @@ -4272,10 +4442,10 @@ make sure you add the following: <li> id <a href="https://github.com/doxygen/doxygen/issues/1837">1837</a>: Two template functions that only differed in the number of template arguments were seen as the same function.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/2505">2505</a>: HIDE_UNDOC_CLASSES did not work properly.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/2786">2786</a>: Fixed problem with syncing the information of - declaration and definition in the presence of an extra forward +<li> id <a href="https://github.com/doxygen/doxygen/issues/2786">2786</a>: Fixed problem with syncing the information of + declaration and definition in the presence of an extra forward declaration in the source code.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/2875">2875</a>: For C# enum values were merged together if the same enum +<li> id <a href="https://github.com/doxygen/doxygen/issues/2875">2875</a>: For C# enum values were merged together if the same enum name was used in different scopes.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/2894">2894</a>: Included patch to handle PROGRAM statement in Fortran as subroutines/functions.</li> @@ -4288,7 +4458,7 @@ make sure you add the following: <li> id <a href="https://github.com/doxygen/doxygen/issues/3379">3379</a>: Segfault/realloc error when a very long path was used.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3388">3388</a>: documented #define with guard caused wrong documentation.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3385">3385</a>: Doxywizard could crash on exit in some cases.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/3392">3392</a>: Regression: a struct ivar in ObjC class screws up method +<li> id <a href="https://github.com/doxygen/doxygen/issues/3392">3392</a>: Regression: a struct ivar in ObjC class screws up method identification.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3396">3396</a>: Included patch that avoids trailing spaces in the generated Doxyfile template.</li> @@ -4297,14 +4467,14 @@ make sure you add the following: not work correctly.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3418">3418</a>: The "more..." link for files was broken, since the anchor was not generated.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/3433">3433</a>: Fixed parsing problem when an unpaired apostrophe +<li> id <a href="https://github.com/doxygen/doxygen/issues/3433">3433</a>: Fixed parsing problem when an unpaired apostrophe appeared in a Python comment.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3446">3446</a>: Included fix for doxywizard makefile. </li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3447">3447</a>: Added missing virtual destructor to CompAccept base class.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3450">3450</a>: Fixed segmentation fault for specific case in PHP code.</li> <li> Fixed some issues building for Windows.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3457">3457</a>: Fixed problem handling strings like a"\b" within a comment.</li> -<li> id <a href="https://github.com/doxygen/doxygen/issues/3459">3459</a>: Fixed problem matching explicitly scoped parameter in a +<li> id <a href="https://github.com/doxygen/doxygen/issues/3459">3459</a>: Fixed problem matching explicitly scoped parameter in a template class.</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/3473">3473</a>: A namespace with name "internal" (C++/CLI keyword) could confuse doxygen's C++ parser.</li> @@ -4333,14 +4503,14 @@ make sure you add the following: </ul> <h3>Bug fixes</h3> <ul> -<li> id 395169: Some links via tagfiles were not correct in +<li> id 395169: Some links via tagfiles were not correct in combination with CREATE_SUBDIRS=YES</li> <li> id 539080: Having the same comment for the declaration and definition - of a function could result in duplicate documentation in case the + of a function could result in duplicate documentation in case the indentation level was different.</li> <li> id 566713: Dot font was not removed even though DOT_CLEANUP was YES.</li> <li> id 566925: Fixed problem resolving symbolic links.</li> -<li> id 567044: Fully qualified name was not shown correctly for nested +<li> id 567044: Fully qualified name was not shown correctly for nested classes.</li> <li> id 567375: Fixed parse problem for typedefs with redundant braces.</li> <li> id 567535: Fixed problem when parsing operator%= for CLI/C++ code.</li> @@ -4352,7 +4522,7 @@ make sure you add the following: <li> id 569478: Fixed line continuation issue with the Fortran parser.</li> <li> id 570960: C++ class defined in a .mm file was sometimes parsed as Objective-C code.</li> -<li> id 571013: In the wizard, editing a text field in the middle of the +<li> id 571013: In the wizard, editing a text field in the middle of the text in the expert tab caused the cursor to jump to the end of the line.</li> <li> id 571096: Fixed Objective-C parsing problem when multiple protocol forward declarations are put on one line.</li> @@ -4371,46 +4541,46 @@ make sure you add the following: <a name="1.5.8"></a> <h3>Changes</h3> <ul> -<li> Completely rewrote the doxywizard. Main changes: +<li> Completely rewrote the doxywizard. Main changes: <ul> <li> It is now based on Qt version 4. (4.3 or higher is required) </li> - <li> Different layout that allows easy switching between wizard + <li> Different layout that allows easy switching between wizard and expert mode, without losing settings.</li> - <li> Running doxygen can be done without first having to save + <li> Running doxygen can be done without first having to save the configuration file.</li> - <li> For HTML output, there is a button to show the results in + <li> For HTML output, there is a button to show the results in the default browser.</li> - <li> Option to change the default configuration that is used + <li> Option to change the default configuration that is used when you first start the wizard.</li> <li> Non-default options are shown with red label, and there is context menu to reset them back to the default.</li> </ul></li> -<li> Included Qt help update by Sebastian Pipping introducing +<li> Included Qt help update by Sebastian Pipping introducing three new options to define custom filter sections and attributes: - <code>QHP_CUST_FILTER_NAME</code>, - <code>QHP_CUST_FILTER_ATTRS</code>, + <code>QHP_CUST_FILTER_NAME</code>, + <code>QHP_CUST_FILTER_ATTRS</code>, <code>QHP_SECT_FILTER_ATTRS</code>. - Doxygen now directly generates the indices needed + Doxygen now directly generates the indices needed by the qthelpgenerator. Qt customers can have a look at issue 28 of the Qt Quarterly for more information.</li> </ul> <h3>New features</h3> <ul> -<li> id 131496, 522488, 541649, 554800: - Add new option EXTENSION_MAPPING, which can be used to - change the +<li> id 131496, 522488, 541649, 554800: + Add new option EXTENSION_MAPPING, which can be used to + change the mapping of file extension to language parser, e.g. defining <code> - EXTENSION_MAPPING = f=C + EXTENSION_MAPPING = f=C </code> will make doxygen parse files with the <code>.f</code> extension as if it were C files.</li> <li> Added support for Vietnamese (thanks to Dang Minh Tuan)</li> <li> Thanks to Emin Ilker Cetinbas doxygen can now also produce Turkish documentation.</li> -<li> id 143218: It is now possible to add the direction attributes - normally used with the @param command to document parameters +<li> id 143218: It is now possible to add the direction attributes + normally used with the @param command to document parameters inline, e.g. <code> void foo(int v /**< [in] input parameter docs */); @@ -4431,10 +4601,10 @@ make sure you add the following: <li> id 532695: included documentation update about the use of \public and friends for object-oriented programming in C.</li> <li> id 532808: References to class variables in PHP code did not already work.</li> -<li> id 536394: Warning "no matching file member found" was given for a static +<li> id 536394: Warning "no matching file member found" was given for a static variables in multiple anonymous namespaces.</li> <li> id 537686: Fixed invalid empty section for enum in a member group.</li> -<li> id 539590: C# generics with the same name but different template +<li> id 539590: C# generics with the same name but different template parameters where merged.</li> <li> id 540321: A using declaration in a header file was not taken into account in the source file that included it.</li> @@ -4460,11 +4630,11 @@ make sure you add the following: inside an if at global scope level of a PHP code fragment.</li> <li> id 556240: Tree view in HTML output was not encoded correctly.</li> <li> id 557001: VHDL Parser got confused when -- is in a string literal.</li> -<li> id 557014: Undocumented VHDL record member's internal record prefix +<li> id 557014: Undocumented VHDL record member's internal record prefix was not removed.</li> -<li> id 557026: Obj-C Protocols and interfaces had wrong +<li> id 557026: Obj-C Protocols and interfaces had wrong type/name in DocSets.</li> -<li> id 557031: Obj-C methods no longer require a space after the +<li> id 557031: Obj-C methods no longer require a space after the initial - or +.</li> <li> id 557034: Fixed problem parsing property in Objective-C code.</li> <li> id 557038: Items in tabs.css could not be overridden by custom @@ -4476,7 +4646,7 @@ make sure you add the following: <li> id 558460: When using \subpage, any section in the sub page was missing from the LaTeX output.</li> <li> id 558525: Template classes produced invalid HTML in the tree view.</li> -<li> id 559338: PHP Parser could get confused when there was a comment inside +<li> id 559338: PHP Parser could get confused when there was a comment inside an array initializer.</li> <li> id 559650: Obj-C @interface without body was handle correctly.</li> <li> id 560623: Mixin template classes where not shown properly in the inheritance @@ -4484,7 +4654,7 @@ make sure you add the following: <li> id 563136: The brief sentence is not shown for groups with no children.</li> <li> id 563384: call graphs were not generated for Qt signals and slots</li> <li> Included VHDL fix by Martin Kreis.</li> -<li> grouping of multiple @todo's (and friends) didn't work anymore, +<li> grouping of multiple @todo's (and friends) didn't work anymore, causing duplicate sections and labels.</li> <li> Some issues related to the Qt help output were fixed.</li> </ul> @@ -4495,7 +4665,7 @@ make sure you add the following: <h3>Changes</h3> <ul> <li> The dot tool is no longer part of the doxygen package for MacOSX. - Please install GraphViz separately and set the dot path + Please install GraphViz separately and set the dot path to /usr/local/bin</li> </ul> <h3>New features</h3> @@ -4508,7 +4678,7 @@ make sure you add the following: <li> id 554432: Re-added ALPHABETICAL_INDEX option.</li> <li> id 554379: Fixed internal error for GENERATE_INDEXLOG when GENERATE_HTML was set to NO.</li> -<li> id 554546: Included fix for handling relative includes in the +<li> id 554546: Included fix for handling relative includes in the preprocessor.</li> <li> Included several VHDL fixes related to syntax highlighting, finding class members, and mixing upper and lower case.</li> @@ -4521,32 +4691,32 @@ make sure you add the following: <a name="1.5.7"></a> <h3>Changes</h3> <ul> -<li> The default CSS style sheet has been cleaned up and simplified, thanks +<li> The default CSS style sheet has been cleaned up and simplified, thanks to the work done by Quinn Taylor.</li> </ul> <h3>New features</h3> <ul> <li> Added new config options <code>GENERATE_QHP</code> - which enables generating .qch (Qt compiled help) file via + which enables generating .qch (Qt compiled help) file via the Qt's qthelpgenerator tool (part of Qt 4.4+). - This type of files can be read with Qt's Assistant to browse the - documentation in a similar way as is possible with Microsoft's + This type of files can be read with Qt's Assistant to browse the + documentation in a similar way as is possible with Microsoft's compiled HTML help (.chm). To further customize the output and run the help generator from within doxygen, the following options - are available: <code>QCH_FILE</code>, <code>QHP_NAMESPACE</code>, - <code>QHP_VIRTUAL_FOLDER</code>, <code>QHG_LOCATION</code>. + are available: <code>QCH_FILE</code>, <code>QHP_NAMESPACE</code>, + <code>QHP_VIRTUAL_FOLDER</code>, <code>QHG_LOCATION</code>. Thanks to Sebastian Pipping for the patch.</li> -<li> Add new option <code>SYMBOL_CACHE_SIZE</code> to allow a different - trade off between doxygen's memory usage and the amount of disk +<li> Add new option <code>SYMBOL_CACHE_SIZE</code> to allow a different + trade off between doxygen's memory usage and the amount of disk accesses.</li> <li> id 532695: Added 3 new commands: \extends, \implements, and \memberof that allow object oriented constructs to be documented as such for languages that do not support it natively (e.g. C)</li> <li> Added better support for one line comments after VHDL types.</li> -<li> Added new option <code>LAYOUT_FILE</code> which can be used to +<li> Added new option <code>LAYOUT_FILE</code> which can be used to specify a layout template file that tells doxygen in which order to generate the - output and which titles to use for headings and how + output and which titles to use for headings and how the navigation index will look; Read <a href="customize.html">this</a> for more info. As a result the following options are now obsolete since they can @@ -4555,24 +4725,24 @@ make sure you add the following: The following options can also be set via the layout file, but for convenience and backward compatibility reasons they are still also part of the configuration file: - <code>SHOW_INCLUDE_FILES</code>, <code>SHOW_USED_FILES</code>, - <code>CLASS_GRAPH</code>, <code>COLLABORATION_GRAPH</code>, - <code>GROUP_GRAPHS</code>, <code>INCLUDE_GRAPH</code>, + <code>SHOW_INCLUDE_FILES</code>, <code>SHOW_USED_FILES</code>, + <code>CLASS_GRAPH</code>, <code>COLLABORATION_GRAPH</code>, + <code>GROUP_GRAPHS</code>, <code>INCLUDE_GRAPH</code>, <code>INCLUDED_BY_GRAPH</code>. Run doxygen with the -l option to generate the default layout file.</li> -<li> Included update for the Macedonian, Catalan, Brazilian, and Serbian +<li> Included update for the Macedonian, Catalan, Brazilian, and Serbian translation and also support for Serbian with Cyrillic characters.</li> </ul> <h3>Bug fixes</h3> <ul> <li> id 140264, 332187, 541924: Sections inside a \subpage where not shown as subsection in the LaTeX/RTF output. </li> -<li> id 155098,156188: Added support for UTF-8 special characters in identifiers (which is +<li> id 155098,156188: Added support for UTF-8 special characters in identifiers (which is allowed by e.g. C#).</li> <li> id 304598: operator-- caused invalid HTML output.</li> <li> id 324047: parameter type [in or out] were not generated in RTF document</li> <li> id 363499: @todo and friends did not work in a comment marked with @dir.</li> -<li> id 445485: HTML commands in a comment block with attribute values without +<li> id 445485: HTML commands in a comment block with attribute values without quotes were not handled properly.</li> <li> id 533855: Processes were always documented as anonymous in VHDL code.</li> <li> id 535379: Added support for %{...%} blocks in XPCOM's IDL.</li> @@ -4587,9 +4757,9 @@ make sure you add the following: <li> id 538239: Some unlabeled VHDL processes were not corrected detected.</li> <li> id 538515: Deriving a Objective-C interface from a protocol caused parsing problems if the interface also has a body.</li> -<li> id 539057: Part of an Objective-C expression could be missing in the +<li> id 539057: Part of an Objective-C expression could be missing in the source browser under certain conditions.</li> -<li> id 539590: Generic C# classes with the same name but different +<li> id 539590: Generic C# classes with the same name but different template arguments were no longer treated as different classes.</li> <li> id 539712: Fixed code parser issue for parameter indices of procedures and functions.</li> @@ -4597,50 +4767,50 @@ make sure you add the following: <li> id 540372: Fixed problem parsing large table by increasing YY_READ_BUF_SIZE in the generated parser files.</li> <li> id 540247: Fixed potential memory corruption issue parsing VHDL.</li> -<li> id 541113: Fixed locale for ctype, to avoid stripping of 0xA0 +<li> id 541113: Fixed locale for ctype, to avoid stripping of 0xA0 from multi-byte UTF-8 characters.</li> <li> id 544479: <code>SORT_MEMBER_DOCS</code> did not work for class members.</li> -<li> id 546621: Fixed makefile so that .svn stuff is removed from the +<li> id 546621: Fixed makefile so that .svn stuff is removed from the tar-ball when doing "make archive".</li> -<li> id 546812: Using a table with row span greater than 1 did not +<li> id 546812: Using a table with row span greater than 1 did not produce correct LaTeX output.</li> <li> id 545098: Fixed problem parsing where clauses in combination with C# generics.</li> <li> id 545503: Nameless parameters of type "struct A" could end up wrongly in the XML output.</li> <li> id 545970: Referring to the main page did not work as advertised.</li> -<li> id 546158: The variable defined inside a foreach statement in C# code +<li> id 546158: The variable defined inside a foreach statement in C# code was not considered for source linking, cause potentially incomplete call graphs.</li> <li> id 547361: Linking to specialized template functions did not work.</li> -<li> id 548175: Fixed problem parsing class members within a class X, +<li> id 548175: Fixed problem parsing class members within a class X, inside a namespace that is also named X.</li> <li> id 548443: Documenting a nested namespace/classes with @namespace X.Y did not work for C# (only X::Y worked).</li> -<li> id 548489: C++/CLI classes of type sealed abstract were not +<li> id 548489: C++/CLI classes of type sealed abstract were not processed correctly.</li> <li> id 549318: Some headings in the user manual where wrongly formatted. </li> <li> id 549581: Fixed potential buffer overflow in preprocessor.</li> <li> id 550058: Obj-C: properties for private fields did not appear in the output unless <code>EXTRACT_PRIVATE</code> was enabled. </li> -<li> id 550156: Corrected typo in the documentation for +<li> id 550156: Corrected typo in the documentation for <code>GENERATE_TREEVIEW</code>.</li> -<li> id 550247: Fixed problem parsing octal character literals in +<li> id 550247: Fixed problem parsing octal character literals in the preprocessing phase.</li> <li> id 551739: Related function with explicit namespace scope was not properly placed if the function also existed in the global namespace.</li> <li> id 552115: Anonymous structs and unions could produce invalid links in the html help index.</li> <li> id 552361: Fixed problem with operators in the LaTeX output.</li> -<li> id 552600: \copybrief ended a brief description instead of appending +<li> id 552600: \copybrief ended a brief description instead of appending to it.</li> <li> id 553469: Removed bogus warning about internal inconsistency when importing items via a tagfiles that are inside an undocumented scope.</li> -<li> id 553616: One can now remove the automatic line breaks in the type +<li> id 553616: One can now remove the automatic line breaks in the type part of a declaration by using a custom stylesheet with BR.typebreak { display: none; }</li> <li> id 553663: Aliases did not work in Fortran comments.</li> -<li> id 549022: Reimplemented in links could be wrong in case of +<li> id 549022: Reimplemented in links could be wrong in case of overloaded members.</li> <li> id 553225: Parser was confused by arrays inside an Obj-C message.</li> <li> Finnish translation was disabled. </li> @@ -4658,9 +4828,9 @@ make sure you add the following: <li> The GENERATE_TREEVIEW option is not longer a boolean, but can now have 4 values, NONE (was NO), FRAME (was YES), HIERARCHIES, and ALL. Thanks to Jake Colman for the patch.</li> -<li> a page marked as a sub page (\subpage) is now shown in the LaTeX and - RTF output as a section of its parent page. So the top level pages are - shown a chapters, subpages as sections, subpages of a subpage as +<li> a page marked as a sub page (\subpage) is now shown in the LaTeX and + RTF output as a section of its parent page. So the top level pages are + shown a chapters, subpages as sections, subpages of a subpage as subsections, etc. </li> <li> Included spec file updates by Kenneth Porter.</li> </ul> @@ -4670,15 +4840,15 @@ make sure you add the following: instructing dot to use a different font than FreeSans.ttf which doxygen put in the output directory.</li> <li> id 517242: Added option CHM_INDEX_ENCODING to specify the encoding - to be used for the CHM index files. Needed because CHM index files + to be used for the CHM index files. Needed because CHM index files cannot handle UTF-8 encoding.</li> <li> id 519573: Included patch to make the font-size button visible in the CHM output.</li> -<li> id 521288: Added new options SHOW_NAMESPACES and SHOW_FILES to +<li> id 521288: Added new options SHOW_NAMESPACES and SHOW_FILES to Suppress Namespace and Files Pages.</li> <li> id 521495: Included a patch that makes it easy to modify the root of the html treeview with an image using style sheets.</li> -<li> id 522300: Added option IDL_PROPERTY_SUPPORT to enable/disable special +<li> id 522300: Added option IDL_PROPERTY_SUPPORT to enable/disable special propget/propput handling in IDL files.</li> <li> Translation support for Finnish has been updated.</li> <li> Added option FORMULA_FONTSIZE which can be used to change the font size @@ -4689,10 +4859,10 @@ make sure you add the following: </ul> <h3>Bug fixes</h3> <ul> -<li> Regression: fixed problem handling STL classes +<li> Regression: fixed problem handling STL classes when BUILTIN_STL_SUPPORT was enabled</li> -<li> id 142866,377976: Added new \copybrief and \copydetails commands, - which work as \copydoc but then only copy either the brief or the +<li> id 142866,377976: Added new \copybrief and \copydetails commands, + which work as \copydoc but then only copy either the brief or the detailed part of a comment block.</li> <li> id 312655: DISTRIBUTE_GROUP_DOC didn't always work in combination with SORT_BRIEF_DOCS enabled.</li> @@ -4701,19 +4871,19 @@ make sure you add the following: <li> id 402447: Added support for C# method declarations with where clauses.</li> <li> id 425029: WARN_FORMAT does no longer require all of $file, $line, $text to be valid.</li> -<li> id 495687: Replaced MAX_DOT_GRAPH_MAX_NODES with DOT_GRAPH_MAX_NODES +<li> id 495687: Replaced MAX_DOT_GRAPH_MAX_NODES with DOT_GRAPH_MAX_NODES in the docs & config file.</li> -<li> id 508694 Fixed problem with mixed simple and double quotes in +<li> id 508694 Fixed problem with mixed simple and double quotes in Fortran format declaration</li> <li> id 508752: Fixed problem where the Fortran scanner didn't recognize END</li> -<li> id 510971: Fortran: parser was confused by double REAL() in processed +<li> id 510971: Fortran: parser was confused by double REAL() in processed statements.</li> <li> id 514488: Fixed problem matching argument lists with const qualifiers.</li> <li> id 514891: PDF generation failed with a LaTeX error when tocdepth was set to a value higher than 2.</li> <li> id 515518: Links in member group documentation was broken when CREATE_SUBDIRS was enabled.</li> -<li> id 516086: Fixed division by zero when producing RTF output for the +<li> id 516086: Fixed division by zero when producing RTF output for the comment /** <table><tr></tr></table> */</li> <li> id 516536: Fixed build issues on OSX 10.4 and earlier.</li> <li> id 516070: Added support for simple events without accessors in C#.</li> @@ -4724,11 +4894,11 @@ make sure you add the following: <li> id 518334: Fixed problem parsing Objective-C protocol definitions.</li> <li> id 518537: Hiding an enum with an undocumented typedef with the same name caused explicit referencing of the enum to fail.</li> -<li> id 519661: In some cases a function prototype could incorrectly be +<li> id 519661: In some cases a function prototype could incorrectly be flagged as a variable with constructor.</li> -<li> id 520325: Fixed parse problem when comment was after an extern "C" +<li> id 520325: Fixed parse problem when comment was after an extern "C" block and before the opening bracket.</li> -<li> id 521234: Fortran: fixed problem causing +<li> id 521234: Fortran: fixed problem causing "stack empty! when parsing code"</li> <li> id 522225: PDF Latex output did not produce proper hyperlinks for \page and \subpage comment blocks.</li> @@ -4737,11 +4907,11 @@ make sure you add the following: <li> id 522600: Added additional warnings to signal invalid configurations.</li> <li> id 523138: Removed redundant paragraph in navigation section of the HTML output. </li> -<li> id 523326: Namespace name was prepended twice to template +<li> id 523326: Namespace name was prepended twice to template specializations classes.</li> -<li> id 524357: Default mentioned for REFERENCED_BY_RELATION relation +<li> id 524357: Default mentioned for REFERENCED_BY_RELATION relation was not correct.</li> -<li> id 524359: Default mentioned for REFERENCES_RELATION relation was +<li> id 524359: Default mentioned for REFERENCES_RELATION relation was not correct.</li> <li> id 524473: Removed incorrect warnings about parameters in VHDL.</li> <li> id 525140: Improved handling of Objective-C 2.0 properties.</li> @@ -4776,7 +4946,7 @@ make sure you add the following: <li> Pages created with @page are now chapters in the LaTeX and RTF output and treeviews, and directly follow the mainpage. Also the project name is not longer repeated for each chapter. - This should make it more convenient to create normal, printable + This should make it more convenient to create normal, printable documentation with doxygen.</li> <li> For dot graphs with an edge with more than ten labels, only the first ten are shown followed by an ellipsis; done to prevent very long @@ -4787,7 +4957,7 @@ make sure you add the following: <code> #define C(S,m) /** container S */ struct S { /** value m */ int m; } </code></li> -<li> id 493923: The options SOURCE_BROWSER, CALL_GRAPH, CALLER_GRAPH, +<li> id 493923: The options SOURCE_BROWSER, CALL_GRAPH, CALLER_GRAPH, REFERENCES_RELATION, and REFERENCED_BY_RELATION can now be independently enabled and disabled. By default the relations are now disabled.</li> </ul> @@ -4796,10 +4966,10 @@ make sure you add the following: <li> Added support for VHDL (.vhd or .vhdl extension) based on a patch by Martin Kreis. Use OPTIMIZE_OUTPUT_VHDL when parsing VHDL code. </li> <li> id 374699: Added support for Objective-C 2.0 properties.</li> -<li> Added compilation support for MacOSX 10.5 (Leopard) in combination with +<li> Added compilation support for MacOSX 10.5 (Leopard) in combination with Xcode 3</li> -<li> Added support for docsets, which allow integration of doxygen generated - API documentation in Xcode 3. new options: +<li> Added support for docsets, which allow integration of doxygen generated + API documentation in Xcode 3. new options: <ul> <li> GENERATE_DOCSET: enables/disables the feature</li> <li> DOCSET_FEEDNAME: sets the provider/suite name under which the set is @@ -4807,7 +4977,7 @@ make sure you add the following: <li> DOCSET_BUNDLE_ID: A unique name for the docset.</li> </ul> See the configuration file or manual for more details.</li> -<li> id 493467: Added compilation support 64bit Solaris machines in +<li> id 493467: Added compilation support 64bit Solaris machines in combination with Sun's own compiler (thanks to Heiko Jansen).</li> <li> id 153376: Added support for the \tparam command, which works similar to \param but is meant for documenting template parameters.</li> @@ -4815,7 +4985,7 @@ make sure you add the following: the second and third argument of a \class command, when the documentation is already in front of a class definition.</li> <li> Added translator support for Macedonian.</li> -<li> Added language updates for German, Persian, Spanish, Taiwanese, +<li> Added language updates for German, Persian, Spanish, Taiwanese, and Chinese, Korean, Croatian.</li> </ul> <h3>Bug fixes</h3> @@ -4826,12 +4996,12 @@ make sure you add the following: <li> Some character's could be missing from IDL properties.</li> <li> Automatic abbreviations did not work for nested classes or classes in a namespace.</li> -<li> Fixed a preprocessor bug where the line numbers of a definition could +<li> Fixed a preprocessor bug where the line numbers of a definition could get out of sync with the source code.</li> <li> id 142023: Putting Qt signals or slots in a group did not make them appear in the group documentation.</li> <li> id 318668: Comments in Python function argument lists got messed up.</li> -<li> id 325359: Added support for C# XML-doc commands typeparam and +<li> id 325359: Added support for C# XML-doc commands typeparam and typeparamref.</li> <li> id 331674: Aliases did not work in Python code.</li> <li> id 356399: Fixed strange warning when specifying a tag file with an @@ -4848,7 +5018,7 @@ make sure you add the following: <li> id 488125: <code>operator->*</code> was not displayed properly in the output.</li> <li> id 490766: Fixed compile error in fortranscanner.l which occurred for some compilers.</li> -<li> id 492027: Ampersand (&) in front of parameter stops documenting +<li> id 492027: Ampersand (&) in front of parameter stops documenting of PHP source</li> <li> id 493249: using a namespace (or Fortran module) caused the namespace to appear in the documentation as if it was defined.</li> @@ -4856,7 +5026,7 @@ make sure you add the following: handled correctly. </li> <li> id 494187: Doxygen could crash due to an infinite recursion when using tag files.</li> -<li> id 494599: When updating a config file an extra space was added just +<li> id 494599: When updating a config file an extra space was added just before the end of a quoted string.</li> <li> id 494760: Putting a # in a path name using Doxywizard, caused the # to interpreted as the start of a comment in the Doxyfile.</li> @@ -4865,16 +5035,16 @@ make sure you add the following: <li> id 496392: Putting character entities like é in section/group titles resulted in &acute; in the output.</li> <li> id 498049: Improvements to .spec files for RPM creation.</li> -<li> id 498680: Callgraphs for functions in anonymous namespaces generated +<li> id 498680: Callgraphs for functions in anonymous namespaces generated invalid labels for 'dot' when EXTRACT_ANON_NSPACES was set to YES.</li> <li> id 498711: Reference parameters in PHP were not properly parsed.</li> <li> id 499577: Collaboration diagrams not working with typedef</li> -<li> id 500227: Wrong output generated for Objective-C methods with +<li> id 500227: Wrong output generated for Objective-C methods with multiple arguments for LaTeX or RTF output.</li> -<li> id 500635: Project name is no longer placed before each top level +<li> id 500635: Project name is no longer placed before each top level item in the treeview and other indices.</li> <li> id 500465: Fixed some issues compiling for AIX.</li> -<li> id 500928: Fixed parser issue handling a tipple quoted +<li> id 500928: Fixed parser issue handling a tipple quoted string when used to initialize a Python variable.</li> <li> id 500944: Python variables with package scope were only extracted if EXTRACT_STATIC was enabled.</li> @@ -4886,7 +5056,7 @@ make sure you add the following: by the source code parser.</li> <li> id 503939: Variable was checked before initialized.</li> <li> id 504120: TYPEDEF_HIDES_STRUCT now also works for enums.</li> -<li> id 504439: Assert when marshaling a member which had an associated +<li> id 504439: Assert when marshaling a member which had an associated example.</li> <li> id 504650: Generated LaTeX code injected hyperlinks into section titles.</li> <li> id 507052: Fortran function named x_function was not properly handled.</li> @@ -4894,13 +5064,13 @@ make sure you add the following: INPUT_FILTER is empty.</li> <li> id 508740: Using upper case port mode specifiers did not work correctly.</li> <li> id 508753: Fortran: Added .f as allowed Fortran extension.</li> -<li> id 508759: Fortran: fixed potential memory corruption while scanning +<li> id 508759: Fortran: fixed potential memory corruption while scanning parameter lists.</li> <li> id 507528: XML output was not correct for pointer arrays.</li> <li> id 508752: Fortran scanner didn't recognize lonely END</li> -<li> id 509278: Spaced before the \internal command where treated as +<li> id 509278: Spaced before the \internal command where treated as documentation.</li> -<li> id 509582: Fortran: Spaces in function return type were not parsed +<li> id 509582: Fortran: Spaces in function return type were not parsed properly.</li> <li> id 510387: Fortran scanner didn't parse initialization of complex type correctly. </li> @@ -4908,7 +5078,7 @@ make sure you add the following: JAVADOC_AUTOBRIEF was enabled.</li> <li> id 512620: \copydoc of a comment with @param commands could result in warnings that parameters were not documented.</li> -<li> id 513570: Fixed cross site scripting vulnerability in the +<li> id 513570: Fixed cross site scripting vulnerability in the search.php script.</li> <li> id 514814: Included missing fromUtf8 calls to translator decoder to prevent potential language encoding issues.</li> @@ -4929,7 +5099,7 @@ make sure you add the following: </ul> <h3>New features</h3> <ul> -<li> Included support for parsing Fortran 90, thanks to a patch by +<li> Included support for parsing Fortran 90, thanks to a patch by Anke Visser and Oleg Batrashev (source: http://dougdevel.org/index.php?page=doxygen)</li> <li> id 477548: Added config option SIP_SUPPORT to support handling SIP sources (used for Python to C++ bindings).</li> @@ -4946,14 +5116,14 @@ make sure you add the following: <li> id 321784: Changed scope resolution algorithm to avoid lookup failures on using directives (thanks to Christoph Schulz for the patch).</li> <li> id 415866: Fixed bug in preprocessor causing "More #endif's than #if's found" warning.</li> -<li> id 426971,465020: A brief description would in some cases be treated as a +<li> id 426971,465020: A brief description would in some cases be treated as a detailed one.</li> -<li> id 430148: Doxygen reported "Internal Inconsistency" for class member inside +<li> id 430148: Doxygen reported "Internal Inconsistency" for class member inside anonymous namespaces.</li> -<li> id 433449,363010: Removed Internal inconsistency when referencing enum values found +<li> id 433449,363010: Removed Internal inconsistency when referencing enum values found in a tag file.</li> <li> id 438282: Line numbers were displayed when using \include inside \example.</li> -<li> id 443942,461433: mscgen was not called correctly on Windows when +<li> id 443942,461433: mscgen was not called correctly on Windows when generating .map files.</li> <li> id 457346: increased the threshold for adding line breaks to the type part of a declaration.</li> @@ -4961,15 +5131,15 @@ make sure you add the following: <li> id 461889: Fixed bogus "no matching class member found" case. </li> <li> id 462051: In certain cases doxygen failed to find the proper inheritance relation.</li> <li> id 462077: Error in LaTeX index generation due to unescaped characters.</li> -<li> id 462159, 143250: Added support for parsing functions/methods returning a - pointer or reference to an array, e.g. a function of the +<li> id 462159, 143250: Added support for parsing functions/methods returning a + pointer or reference to an array, e.g. a function of the form: "int (*f(int))[];"</li> <li> id 462436: Inheritance from an unknown template class was not handled consistently.</li> <li> id 462439: Adjusted \author documentation.</li> <li> id 462757: Fixed Latex output bug for members of anonymous struct or unions. </li> <li> id 462861: Members references via tagfiles were sometimes broken.</li> <li> id 463139: Doxygen failed to detect duplicate variable declarations in the same file.</li> -<li> id 465138: HTML entities in page title (such as ü) where not displayed +<li> id 465138: HTML entities in page title (such as ü) where not displayed correctly in the HTML output.</li> <li> id 465170: Wrong line numbers reported for errors when using multiline formulas.</li> <li> id 465172: Fixed issues parsing <code>operator</code>.</li> @@ -4984,7 +5154,7 @@ make sure you add the following: <li> id 470029: Fixed crash while parsing a particular piece of PHP code.</li> <li> id 471185: The word "property" was stripped from functions that started with it.</li> <li> id 471495: Objective C category documentation was ignored in some cases.</li> -<li> id 472193: Fixed issue expanding multiple occurrences of the same alias command +<li> id 472193: Fixed issue expanding multiple occurrences of the same alias command argument.</li> <li> id 472201: Removed spurious warning introduced by the fix for bug 465170.</li> <li> id 473105: Auto link to nested class inside a base class was missing. </li> @@ -4992,7 +5162,7 @@ make sure you add the following: <li> id 473402: context dependent \ref's inside a dot or msc graph did not work anymore.</li> <li> id 473679: Doxygen skipped function if return type contained round parenthesis.</li> <li> id 474529: index entries in LaTeX could be wrong on some platforms.</li> -<li> id 476035: Externally referenced links obtained via a tag file had an extra g in +<li> id 476035: Externally referenced links obtained via a tag file had an extra g in the anchor</li> <li> id 476562: argument of copydoc appears in XML output without proper escaping.</li> <li> id 476766: Type of a virtual destructor was "virtual" in the XML output.</li> @@ -5003,7 +5173,7 @@ make sure you add the following: <li> id 481107: Using HTML_FILE_EXTENSION to set a non-default extension did not work for the "no frames" link to main.html when GENERATE_TREEVIEW was enabled.</li> <li> id 481827: Macro expansion removed the @ character when it appear in a C comment.</li> -<li> id 482964: The "template" word was a little too close to the rounded border in +<li> id 482964: The "template" word was a little too close to the rounded border in the html output when rendered by Firefox.</li> <li> id 484277: Adjusted the instructions to report a bug in the hope this will result in less duplicate bugs.</li> @@ -5012,7 +5182,7 @@ make sure you add the following: <li> id 488760: Added support for Trigraphs to doxygen's C-preprocessor.</li> <li> id 488800: Fixed problem in perlmod generation.</li> <li> id 488837: abstract class in PHP was not properly parsed.</li> -<li> id 489049: Setting MUTLILINE_CPP_IS_BRIEF to YES could cause wrong line number +<li> id 489049: Setting MUTLILINE_CPP_IS_BRIEF to YES could cause wrong line number references.</li> <li> Call graphs were not properly synced between function declaration and definition.</li> <li> Fixed bug in doxygen's internal caching mechanism which could make doxygen @@ -5026,7 +5196,7 @@ make sure you add the following: <ul> <li> When <code>OPTIMIZE_OUTPUT_FOR_C</code> is enabled then a struct definition of the form <code>typedef struct _S { ... } S_t</code> will be shown in the output as a - struct of type <code>S_t</code> and the typedef itself is omitted + struct of type <code>S_t</code> and the typedef itself is omitted (previously <code>_S</code> was shown as well as a typedef of the form <code>typedef _S S_t</code>). </li> <li> Improved the line-breaking rules for members whose return types have many characters @@ -5039,11 +5209,11 @@ make sure you add the following: </ul> <h3>New features</h3> <ul> -<li> Added support for aliases with arguments, +<li> Added support for aliases with arguments, see <a href="custcmd.html">the manual</a> for more information.</li> -<li> Added <code>HTML_DYNAMIC_SECTIONS</code> option which, when enabled, - will produce sections +<li> Added <code>HTML_DYNAMIC_SECTIONS</code> option which, when enabled, + will produce sections in the HTML output that can be expanded/collapsed. Currently used for diagrams and graphs.</li> <li> Added support for type constraints as available in the C# language ("where" clause)</li> @@ -5062,11 +5232,11 @@ make sure you add the following: <li> id 153362: A typedef of a function pointer was not shown correctly in the output.</li> <li> id 156003: Wrong template arguments when using @related for a (template) function with a template class.</li> -<li> id 170004: The check for PDF or DVI in the generated latex output +<li> id 170004: The check for PDF or DVI in the generated latex output was not always reliable.</li> <li> id 300022: PHP code with unknown extension was parsed as C/C++ code. Added a detection rule for <?php to switch to PHP parsing.</li> -<li> id 317967: Setting <code>USE_PDFLATEX</code> to <code>YES</code> now generates a +<li> id 317967: Setting <code>USE_PDFLATEX</code> to <code>YES</code> now generates a Makefile with a "pdf" target, to be consistent with the documentation.</li> <li> id 397099: Fixed several cases where "referenced by" relation was unresolved.</li> @@ -5079,20 +5249,20 @@ make sure you add the following: <li> id 431202, 333607: Quotes inside strings caused the Pythons parser to get off track.</li> <li> id 431763: doxygen crashes when using unsupported tags in the config file.</li> <li> id 432420: Last enum value of a Java 1.5 style enum with constructor did not appear.</li> -<li> id 432743: The "std" namespace appeared in the output when +<li> id 432743: The "std" namespace appeared in the output when <code>BUILTIN_STL_SUPPORT</code> was enabled.</li> -<li> id 432757: Setting <code>INLINE_INHERITED_MEMBERS</code> to <code>YES</code>, +<li> id 432757: Setting <code>INLINE_INHERITED_MEMBERS</code> to <code>YES</code>, did not inherit the group of grouped members of a base class.</li> <li> id 433630: Using double-quotes (") inside a brief description could lead to errors in dot files when the brief description was used as a tooltip.</li> -<li> id 434079: The number of graph nodes could still be too large despite a +<li> id 434079: The number of graph nodes could still be too large despite a conservative <code>DOT_GRAPH_MAX_NODES</code> setting.</li> <li> id 436648: List of class members was no longer complete under certain conditions.</li> -<li> id 437218: Special characters in \brief string cause problems HTML/XML in source +<li> id 437218: Special characters in \brief string cause problems HTML/XML in source listings.</li> -<li> id 438300: Fixed two cases where doxygen could access memory outside array +<li> id 438300: Fixed two cases where doxygen could access memory outside array boundaries under certain conditions.</li> -<li> id 441114: Add support for <term> inside <list> to conform to +<li> id 441114: Add support for <term> inside <list> to conform to C# XML comments.</li> <li> id 442313: Casing of special commands was not handled consistently.</li> <li> id 443942: Fixed problems running mscgen.</li> @@ -5102,15 +5272,15 @@ make sure you add the following: arguments of the type "T%".</li> <li> id 447133: Replaced occurrences of ' by ' in the HTML output.</li> <li> id 448210: Make rule to install manpages was broken.</li> -<li> id 451297: Fixed more issues where using double-quotes (") inside a brief - description could lead to errors in dot files when the brief +<li> id 451297: Fixed more issues where using double-quotes (") inside a brief + description could lead to errors in dot files when the brief description was used as a tooltip.</li> <li> id 452824: In the source browser linking of a local variable did not work after a sizeof() of the variable.</li> -<li> id 452828: Missing reference to struct member in the source browser due to +<li> id 452828: Missing reference to struct member in the source browser due to incorrect bracket count.</li> <li> id 453366: Removed bogus warning for unresolved references in brief descriptions. </li> -<li> id 453918: The __init__.py files were incorrectly treated as modules causing +<li> id 453918: The __init__.py files were incorrectly treated as modules causing scoping issues for symbols defined inside such file.</li> <li> id 456471: Changing the installation location (--prefix) did not affect the location were the documentation was installed. --docdir can still @@ -5131,40 +5301,40 @@ make sure you add the following: <h3>Changes</h3> <ul> <li> The options <code>MAX_DOT_GRAPH_WIDTH</code>, <code>MAX_DOT_GRAPH_HEIGHT</code>, and <code>MAX_DOT_GRAPH_DEPTH</code> have - been replaced by a single option <code>DOT_GRAPH_MAX_NODES</code>, which can be used to - limit the size of a graph indirectly, by specifying the maximum amount of nodes in - the graph. The main advantage is that this can be computed much faster; dot has - to be run only once per graph and never on graphs with more than the specified - amount of nodes. Note that doxygen will always render the root node and its + been replaced by a single option <code>DOT_GRAPH_MAX_NODES</code>, which can be used to + limit the size of a graph indirectly, by specifying the maximum amount of nodes in + the graph. The main advantage is that this can be computed much faster; dot has + to be run only once per graph and never on graphs with more than the specified + amount of nodes. Note that doxygen will always render the root node and its direct children even when <code>DOT_GRAPH_MAX_NODES = 0</code>.</li> <li> Parameters names are now copied to reimplemented functions, avoiding warnings about missing or wrong parameter names when <code>INHERIT_DOCS = YES</code>.</li> </ul> <h3>New features</h3> <ul> -<li> id 150916,159291,166209,330109,396316 - Doxygen now uses UTF-8 internally for all strings and uses +<li> id 150916,159291,166209,330109,396316 + Doxygen now uses UTF-8 internally for all strings and uses iconv to recode the input to UTF-8. For HTML, LaTeX and man pages - the output is now always UTF-8. For RTF the encoding is local and + the output is now always UTF-8. For RTF the encoding is local and depends on the code page specified in the translator. The config option <code>USE_WINDOWS_ENCODING</code> has been removed. A new config option <code>INPUT_ENCODING</code> has been added which can be used to specify the encoding of the input. Another config option <code>DOXYFILE_ENCODING</code> can be used to specify the encoding of the config file itself.</li> <li> Added support for message sequence charts (using mscgen). - For this two new commands have been added: \msc and \endmsc (similar + For this two new commands have been added: \msc and \endmsc (similar to \dot..\enddot), and a new config option <code>MSCGEN_PATH</code> (similar to DOT_PATH) See the manual and <a href="http://www.mcternan.me.uk/mscgen/index.html">website</a> for more info.</li> -<li> Added support for C++/CLI. To enable it set <code>CPP_CLI_SUPPORT</code> to <code>YES</code> in the +<li> Added support for C++/CLI. To enable it set <code>CPP_CLI_SUPPORT</code> to <code>YES</code> in the config file (thanks to Ben Voigt for doing a lot of the work).</li> <li> <code>IGNORE_PREFIX</code> now also works for function/members names when shown in the various indices.</li> -<li> Doxygen will show a tooltip in the HTML output for links to classes, namespaces, +<li> Doxygen will show a tooltip in the HTML output for links to classes, namespaces, and members with the brief description (including dot graphs and source code).</li> -<li> id 321575: Added a new config option <code>EXCLUDE_SYMBOLS</code> which can be used to +<li> id 321575: Added a new config option <code>EXCLUDE_SYMBOLS</code> which can be used to exclude certain namespaces/classes/functions from the output by specifying their name (which may include wildcards).</li> -<li> id 364536: Included patch by Ben Voigt which adds syntax highlight +<li> id 364536: Included patch by Ben Voigt which adds syntax highlight support for several (managed) C++ keywords.</li> <li> id 419349: Added two LaTeX layout enhancements provided by Stefan Pawig. </li> </ul> @@ -5179,7 +5349,7 @@ make sure you add the following: <li> id 322806: Doxygen now does not treat >> in a template list as a shift operator for Java and C#.</li> <li> id 332815: Legend generated with <code>GENERATE_LEGEND</code> did have typo.</li> -<li> id 345820: Included patch to make doxygen handle config files with +<li> id 345820: Included patch to make doxygen handle config files with <code>@INCLUDE</code> with absolute paths correctly.</li> <li> id 364780: Included patch to improve scope handling of nested classes/namespaces by the code parser (thanks to Ben Voigt).</li> @@ -5189,13 +5359,13 @@ make sure you add the following: <li> id 369499: In some cases variable names were duplicated in python source code output.</li> <li> id 369200: Fixed parse problem when a single quote appeared in a Python comment line.</li> <li> id 373229: Doxygen now gives a warning when it cannot inline a #include inside a body </li> -<li> id 374486: Inheriting from a template argument via an intermediate typedef could +<li> id 374486: Inheriting from a template argument via an intermediate typedef could result in invalid output.</li> <li> id 375073: \ref could cause wrong XML output.</li> <li> id 375753: Added missing new line to error message.</li> <li> id 377911: Fixed problem with end of formula.</li> <li> id 380516: Fixed line number issue in the Python parser.</li> -<li> id 381450: Tabs in the HTML output redefined the value of an "id" attribute, +<li> id 381450: Tabs in the HTML output redefined the value of an "id" attribute, which is not legal HTML.</li> <li> id 374592: Member grouping didn't work properly for constructors.</li> <li> id 381608: Initializer values of class variables and constants did no longer @@ -5223,7 +5393,7 @@ make sure you add the following: and as a result cause "Undocumented function" warnings.</li> <li> id 418920: Doxygen stripped leading comment chars from C# code blocks.</li> <li> id 421131: Character encoding was not consistent for all HTML files.</li> -<li> The "list of all members" was not shown for a class with no members that derived +<li> The "list of all members" was not shown for a class with no members that derived from a class with members.</li> </ul> @@ -5234,7 +5404,7 @@ make sure you add the following: <ul> <li> id 148567: @todo at the end of a comment block caused problem when copied by @copydoc</li> <li> id 352420: Fixed bug in LaTeX output (missing space after \bf).</li> -<li> id 363227: missing output for instance variables defined in a Python function +<li> id 363227: missing output for instance variables defined in a Python function that has a doc string</li> <li> id 363397: Member groups did not appear in a class when SUBGROUPING was set to YES.</li> <li> id 364341: Parsing could become really slow if often included header files contained @@ -5254,20 +5424,20 @@ make sure you add the following: <h3>Changes</h3> <ul> <li> cleaned up the internal structures to make them smaller, and made doxygen use - a temporary file to store the parse results (instead of keeping them in memory), - which will further reduce the memory usage, especially for large projects, and is a + a temporary file to store the parse results (instead of keeping them in memory), + which will further reduce the memory usage, especially for large projects, and is a first step towards incremental parsing.</li> </ul> <h3>New features</h3> <ul> -<li> Added example application that shows how to configure and run doxygen from +<li> Added example application that shows how to configure and run doxygen from within an application and use the information collected by doxygen without also generating the output (see addon/doxyapp).</li> <li> id 322467: Sections produces by \note, \warning, \remarks etc, now have a - class label in the generated HTML (<dl> tag) so you can give them a + class label in the generated HTML (<dl> tag) so you can give them a distinct style using a non-default stylesheet (i.e. using HTML_STYLESHEET). </li> <li> Added project files for building doxygen from Visual Studio 2005 (see winbuild dir). </li> -<li> added translator updates for Czech, Danish, German, Catalan, Croatian, French, +<li> added translator updates for Czech, Danish, German, Catalan, Croatian, French, Japanese, and Italian.</li> <li> added translator support for Arabic (thanks to Moaz Reyad)</li> <li> added translator support for Persian (thanks to Ali Nadalizadeh)</li> @@ -5282,9 +5452,9 @@ make sure you add the following: <li> id 325337: Added "optimize output for C#" option to Doxywizard.</li> <li> id 325426: Partial C# class inside a namespace where not handled properly.</li> <li> id 327358: Fixed wrong link to the search engine when CREATE_SUBDIRS was set to YES.</li> -<li> id 326885: Leading ///'s ended up in code fragments when using indented +<li> id 326885: Leading ///'s ended up in code fragments when using indented /// comments.</li> -<li> id 330513: For file documentation, the scope not stripped for namespace members +<li> id 330513: For file documentation, the scope not stripped for namespace members even if HIDE_SCOPE_NAMES was set to YES.</li> <li> id 335131: Fixed "internal inconsistency" warning related to use of nested classes defined outside a used namespace.</li> @@ -5307,7 +5477,7 @@ make sure you add the following: <li> id 348259: Doxygen now keeps the _formulas.log file when there is a problem generating bitmaps for formulas. This can help to identify the problem quicker.</li> <li> id 348481: friend class in unnamed namespace produced bogus error.</li> -<li> id 348537: Fixed internal inconsistency warning that could occur when reopening +<li> id 348537: Fixed internal inconsistency warning that could occur when reopening an anonymous namespace </li> <li> id 349867: Fixed issue handling brief and detailed description when both are positioned after an item. </li> @@ -5318,7 +5488,7 @@ make sure you add the following: and namespaces as it does for classes.</li> <li> id 354765: A command like \ingroup now ends a brief description as was the case in the pre 1.4.x series.</li> -<li> id 355922: When a function was found in a namespace but also in the global +<li> id 355922: When a function was found in a namespace but also in the global namespace, doxygen could make the wrong cross-reference.</li> <li> id 356204: Setting HIDE_UNDOC_RELATIONS to NO could result in argument mismatches in certain cases.</li> @@ -5359,9 +5529,9 @@ make sure you add the following: a caller (or called-by) graph to a function or all functions. (thanks to Daniel Sherwood for the patch)</li> <li> Added REFERENCES_LINK_SOURCE config option which allows to selected - if reference relations should point to the source or to the + if reference relations should point to the source or to the documentation (thanks to Daniel Sherwood for the patch).</li> -<li> Included patch by Christoph Pesch to mention the member type in the +<li> Included patch by Christoph Pesch to mention the member type in the warning "Member ... of ... is not documented".</li> <li> included update for Spanish, Italian, Norwegian, and Czech translations.</li> <li> Added support for get/set properties in IDL (thanks to a patch by @@ -5369,26 +5539,26 @@ make sure you add the following: </ul> <h3>Bug fixes</h3> <ul> -<li> id 151959: incremental "using" of nested namespaces could prevent +<li> id 151959: incremental "using" of nested namespaces could prevent that doxygen matched function declaration against definition.</li> <li> id 310521: HIDE_IN_BODY_DOCS was longer working.</li> <li> id 315039: Improved handling of members in an anonymous scope. </li> <li> id 322415: Under certain conditions a scrollbar appeared in a HTML page while this was not needed.</li> -<li> id 325845: Documentation parser was confused when starting a HTML list +<li> id 325845: Documentation parser was confused when starting a HTML list directly after a \b command.</li> <li> id 325866: SORT_BY_SCOPE_NAME=YES did not always work if SORT_BRIEF_DOCS was also enabled.</li> <li> id 326023: CHM files had @ signs in CHM index for anonymous class enums</li> <li> id 326250: Fixed incorrect regular expression in constexp.l</li> -<li> id 326688: Added better support for PHP5 style constructors +<li> id 326688: Added better support for PHP5 style constructors and destructors.</li> <li> id 326885: Using multi-line //!-blocks did not work nicely together with @code...@endcode blocks anymore.</li> <li> id 327242: Python: Methods starting with _ are now marked private, except for special method names (i.e. starting and ending with __).</li> <li> id 327666: Fixed parse issue that resulted in a missing call graph.</li> -<li> id 328435: When enabling USE_PDFLATEX a blank line appeared in the +<li> id 328435: When enabling USE_PDFLATEX a blank line appeared in the makefile</li> <li> id 328849: Added clarification to the manual about the use of //!< comments.</li> @@ -5398,37 +5568,37 @@ make sure you add the following: a missing argument.</li> <li> id 329530: An apostrophe in ##-comments inside a Python class confused the parser.</li> -<li> id 329534: Fixed problem resolving inheritance relations for nested +<li> id 329534: Fixed problem resolving inheritance relations for nested Python classes.</li> <li> id 329537: Corrected the Python example to show how modules should be documented.</li> -<li> id 329719: # comment in PHP containing a ' caused doxygen to ignore +<li> id 329719: # comment in PHP containing a ' caused doxygen to ignore rest of input.</li> <li> id 329861: Fixed problem parsing embedded structs in an Objective-C interface.</li> -<li> id 329905: PDF manual produced a LaTeX error because style sheet +<li> id 329905: PDF manual produced a LaTeX error because style sheet was not up to date.</li> -<li> id 330209: A typedef in an Obj-C implementation file could obscure +<li> id 330209: A typedef in an Obj-C implementation file could obscure class implementation later in the file</li> -<li> id 331511: no matching class member found error for class template +<li> id 331511: no matching class member found error for class template instance in combination with "using" of said class.</li> <li> id 331751: Fixed problem parsing a function typedef.</li> -<li> id 332110: method matching failed for equivalent template instance +<li> id 332110: method matching failed for equivalent template instance types.</li> <li> id 332178: Fixed malformed XML output for readable properties.</li> <li> id 333270: Fixed BoundingBox problem with PostScript graphs generated - with dot using graphviz-2.9.20060302.0540 and later (thanks to + with dot using graphviz-2.9.20060302.0540 and later (thanks to John Ellison for the patch)</li> <li> id 332875: Enabling SEPARATE_MEMBER_PAGES could lead to bogus warning - messages about undocumented parameters if only the HTML output was + messages about undocumented parameters if only the HTML output was enabled.</li> <li> id 333330: Patch the reorganizes the treeview.</li> -<li> id 333831: "typedef const struct { } NAME" construction was not +<li> id 333831: "typedef const struct { } NAME" construction was not properly parsed.</li> <li> id 334716: Doxygen could hang when calling latex with invalid formulas.</li> -<li> id 336467: Latex formula could prevent /// comment blocks to be properly +<li> id 336467: Latex formula could prevent /// comment blocks to be properly converted to /** */ blocks.</li> -<li> id 336782: Prevented crash when providing code with illegal/redundant +<li> id 336782: Prevented crash when providing code with illegal/redundant class scope.</li> <li> id 337344: Configure now accept system's /usr/bin/install on FreeBSD.</li> <li> id 341365: @endcode comment was skipped in a specific case.</li> @@ -5442,13 +5612,13 @@ make sure you add the following: (thanks to Shachar Itzhaky for the patch)</li> <li> Included patch by Ernst Giessmann, which prevents most of the underfull hbox warnings that are produced when compiling doxygen's LaTeX output.</li> -<li> Fixed potential crash during preprocessing if C-macros are defined +<li> Fixed potential crash during preprocessing if C-macros are defined with /* (thanks to Günther Haslauer for the patch).</li> -<li> Anonymous struct members could end up in the wrong scope +<li> Anonymous struct members could end up in the wrong scope (thanks to Bruno Andrillon for the patch).</li> <li> saving to an existing file in doxywizard now requires a confirmation.</li> <li> Fixed potential crash in case a template class with a redundant - namespace qualifier was used: + namespace qualifier was used: e.g. "namespace N { template<> class N::C<G::H> {}; }"</li> </ul> @@ -5462,7 +5632,7 @@ make sure you add the following: </ul> <h3>Bug fixes</h3> <ul> -<li> id 145294: Boolean expression with '<' as template argument confused +<li> id 145294: Boolean expression with '<' as template argument confused doxygen.</li> <li> id 303297: The class hierarchy was sometimes incorrectly shown.</li> <li> id 317819: Updated the documentation concerning the creation of PDF @@ -5475,11 +5645,11 @@ make sure you add the following: pages not be styled as tabs. Also, links to include dependency graphs had wrong links or were incomplete.</li> <li> id 318564: Python: parser skipped comment blocks in some cases.</li> -<li> id 318565: Python: single quote doc strings did not get parsed properly +<li> id 318565: Python: single quote doc strings did not get parsed properly if there was no space before the closing '''.</li> <li> id 318567: Python: parse problem when () appear in default value of a function parameter.</li> -<li> id 318618: If INLINE_INHERITED_MEMB = YES constructors of a +<li> id 318618: If INLINE_INHERITED_MEMB = YES constructors of a template class were shown in the derived class.</li> <li> id 318678: Python: A referenced variable that was not found using docstring could lead to memory corruption.</li> @@ -5488,26 +5658,26 @@ make sure you add the following: <li> id 319341: Doxygen crashed while generating call graph under certain circumstances.</li> <li> id 319539: Fixed parse problem with Python/Objective-C code.</li> -<li> id 319586: tabs.css not correctly included with CREATE_SUBDIRS option +<li> id 319586: tabs.css not correctly included with CREATE_SUBDIRS option set.</li> -<li> id 318460: Multiply-defined labels if two function specializations +<li> id 318460: Multiply-defined labels if two function specializations differ only on the name of a template parameter.</li> <li> id 319219: Spurious space was inserted after inlined math formulas.</li> -<li> id 319826: The file name for template classes could become too +<li> id 319826: The file name for template classes could become too long causing files that cannot be created by some file systems.</li> -<li> id 320026: undocumented "typedef struct foo baz" causes subsequent +<li> id 320026: undocumented "typedef struct foo baz" causes subsequent variables appear as typedefs.</li> <li> id 320543: If enabled the alphabetical class list is now the default item under the classes tab.</li> -<li> id 320587: Links in brief file descriptions shown in directory pages +<li> id 320587: Links in brief file descriptions shown in directory pages were broken if CREATE_SUBDIRS was enabled.</li> -<li> id 320693: First sentence in mainpage was missing with +<li> id 320693: First sentence in mainpage was missing with JAVADOC_AUTOBRIEF enabled.</li> <li> id 320740: Added support for documenting individual elements of an associative array in PHP.</li> <li> id 320813: The if() statement with space after the if confused the code parser and resulted in partial call graphs.</li> -<li> id 320960: redundant line continuation characters were not removed +<li> id 320960: redundant line continuation characters were not removed by doxygen's C-preprocessor.</li> <li> id 321165: Doxygen choked on Qt properties with namespaced types</li> <li> id 321197: using a namespace that contains a nested class, where the @@ -5520,20 +5690,20 @@ make sure you add the following: properly if there was a space between the name and the size, i.e. struct {} Var [10];</li> <li> id 321682: Fixed typo in the HTML output of the search page.</li> -<li> id 321743: Cross-references were missing to members of +<li> id 321743: Cross-references were missing to members of anonymous structs.</li> -<li> id 311833: A template specialization of a private class member was +<li> id 311833: A template specialization of a private class member was marked as public.</li> -<li> id 312329: @link label @endlink, i.e without link text now shows +<li> id 312329: @link label @endlink, i.e without link text now shows the label as text, and space after label is omitted.</li> -<li> id 312624: \verbatim block could cause wrong line numbers while +<li> id 312624: \verbatim block could cause wrong line numbers while parsing the source code.</li> -<li> id 322752: Fixed specific case where aliases were incorrectly expanded +<li> id 322752: Fixed specific case where aliases were incorrectly expanded inside environment formulas</li> -<li> id 322997: Putting function-style macros in a parameter of a +<li> id 322997: Putting function-style macros in a parameter of a template return type of a function confused doxygen's parser.</li> -<li> id 323320: An enum name that also appears as a typedef - (i.e. typedef T {} T; }) is now linked as an enum and the typedef is +<li> id 323320: An enum name that also appears as a typedef + (i.e. typedef T {} T; }) is now linked as an enum and the typedef is omitted from the output.</li> <li> id 323557: Bit field information was missing from the XML output.</li> <li> id 323627: Fixed compiler warning when using gcc 4.x.</li> @@ -5543,18 +5713,18 @@ make sure you add the following: <li> id 324076: Fixed some typos in the documentation.</li> <li> id 324153: The configure script didn't work for SunOS 5.8.</li> <li> id 324163: \todo paragraph did not end at \author (or similar commands).</li> -<li> id 324313: Added support for having a Linux system where libraries are +<li> id 324313: Added support for having a Linux system where libraries are located in lib64 by adding a new platform to tmake: linux-64</li> <li> id 324521: Autolinking to classes in a group which itself was in a namespace didn't work without explicit scoping.</li> <li> id 324558: Null pointer dereference in namespacedef.cpp</li> -<li> id 324565: References and callgraphs missing for some functions +<li> id 324565: References and callgraphs missing for some functions (thanks to a patch by Dave Dodge).</li> -<li> id 324566: Fixed problem matching +<li> id 324566: Fixed problem matching f(unsigned long const a) against f(unsigned long)</li> -<li> id 324568: Fixed problem were some function prototypes were detected +<li> id 324568: Fixed problem were some function prototypes were detected as variable constructor calls (thanks to Dave Dodge for the patch).</li> -<li> id 324601: Cross referencing and call graphs were broken by +<li> id 324601: Cross referencing and call graphs were broken by certain bracket positions for functions.</li> <li> id 324823: Doxygen's code parser lost track in some cases, causing function definitions not being found in some cases.</li> @@ -5565,9 +5735,9 @@ make sure you add the following: <a name="1.4.5"></a> <h3>Changes</h3> <ul> -<li> Changed to way the index looks (I hope you like it!). +<li> Changed to way the index looks (I hope you like it!). It now is a list of items styled (with CSS) as a row of tabs. - Also class/namespace/file related items are now grouped together and + Also class/namespace/file related items are now grouped together and presented as a second row of tabs to prevent clutter (the latter is based on the suggestions/patch in bug report 162968). Note that if you use a custom HTML header you need to add @@ -5583,8 +5753,8 @@ make sure you add the following: This helps with matching of argument lists for function declarations and definitions and also helps to improve the collaboration and inheritance diagrams that involve STL classes.</li> -<li> id 317010: Added support for the following new HTML entities: - &lsquo; &rsquo; &ldquo; &rdquo; &ndash; +<li> id 317010: Added support for the following new HTML entities: + &lsquo; &rsquo; &ldquo; &rdquo; &ndash; &mdash; (thanks to a patch by madalexonline)</li> <li> Included update for Chinese translation.</li> <li> included update for the VC++ project files (in wintools dir), thanks @@ -5594,27 +5764,27 @@ make sure you add the following: <ul> <li> id 304339: Using \dot in latex formulas conflicted with the doxygen's \dot command.</li> -<li> id 306076: Using a namespace inside an example listed with +<li> id 306076: Using a namespace inside an example listed with @example did not work.</li> <li> id 306069: Search engine required lower case names in order to find something, which made pasting of names difficult.</li> <li> id 308395: Doxygen could crash when producing a warning that included a %s sequence.</li> -<li> id 311191: Default values for parameters weren't shown in the detailed +<li> id 311191: Default values for parameters weren't shown in the detailed documentation.</li> <li> id 311198: If JAVADOC_AUTOBRIEF was set to YES, a \todo or \bug like command always ended at the first dot.</li> -<li> id 311207: The /* and */ inside a \code ... \endcode code fragment +<li> id 311207: The /* and */ inside a \code ... \endcode code fragment were stripped.</li> <li> id 311577: Putting a documented class name in the title of the main page caused a LaTeX error if pdf hyperlinks were enabled.</li> <li> id 311665: Fixed compile issue for Solaris.</li> -<li> id 312688: Typedefs of arrays were auto-linked to the base type +<li> id 312688: Typedefs of arrays were auto-linked to the base type i.s.o the typedef.</li> -<li> id 312678: Fixed excessive memory usage for @fn commands - due to a memory leak of the scanner buffer 256K of memory was leaked +<li> id 312678: Fixed excessive memory usage for @fn commands + due to a memory leak of the scanner buffer 256K of memory was leaked for each command!</li> -<li> id 312791: Undocumented members did not result in warnings if +<li> id 312791: Undocumented members did not result in warnings if SOURCE_BROWSER was enable and the member's definition was part of the INPUT.</li> <li> A C-comment inside a \code block could lead to parse problems in the @@ -5628,17 +5798,17 @@ make sure you add the following: is enabled).</li> <li> id 313011: Item after the closing of a nested group was ignored in some cases.</li> -<li> id 313103: Member groups within other nested groups did not work +<li> id 313103: Member groups within other nested groups did not work anymore.</li> <li> id 313298: Code parser didn't handle function-try-blocks correctly.</li> <li> id 313572: Fixed lockup issue when generation code for Python files.</li> -<li> id 313695: Fixed parsing issues for the constructs +<li> id 313695: Fixed parsing issues for the constructs "\f$n\f$" and "operator <CODE>". </li> -<li> id 313805: '@' characters in a string literal were lost during +<li> id 313805: '@' characters in a string literal were lost during macro expansion.</li> <li> id 313906: added support for "import" and "from ... import" to the Python parser so cross module inheritance works.</li> -<li> id 313908: Fixed python parser problem: If there are two classes +<li> id 313908: Fixed python parser problem: If there are two classes defined in one module there needed to be a comment between them.</li> <li> id 314165: Python functions starting with _ are not marked as public, whereas variables starting with _ are marked private.</li> @@ -5647,31 +5817,31 @@ make sure you add the following: <li> id 314237: You can now also use \ref on directories documented with \dir.</li> <li> id 314288: Using \ref with an ambiguous filename didn't work.</li> -<li> id 315006: C++ comments at the start of a line and +<li> id 315006: C++ comments at the start of a line and inside a <pre>..</pre> block were stripped.</li> <li> id 316264: Fixed typo in the inline config file documentation.</li> -<li> id 316266: Included update for the Japanese translation (thanks to +<li> id 316266: Included update for the Japanese translation (thanks to Katsuhiro Hermit Endo)</li> <li> id 316759: Fixed problem in the Makefile of doxywizard so that the right version appears in the about box.</li> -<li> id 316944: An inline formula (or other special command) did not get - executed if it was within an inline documentation block and +<li> id 316944: An inline formula (or other special command) did not get + executed if it was within an inline documentation block and put after a parameter.</li> <li> id 317052: The alphabetical class index was not sorted properly if multiple prefixes were specified using IGNORE_PREFIX. </li> <li> id 317105: Latex output expanded &szlig; as "s instead of {\ss} which only worked if german.sty was included. Thanks to Stefan Pawig for the patch)</li> -<li> id 317397: Copying of images from subdirectory within the IMAGE_PATH +<li> id 317397: Copying of images from subdirectory within the IMAGE_PATH didn't work properly since doxygen didn't remove the subdirectory from the destination path.</li> <li> id 317446: Documenting an enum with \enum while there is also a function with the same name in the same scope could make the enum documentation appear at the wrong spot or the enum in the wrong member group.</li> <li> id 317490: A variable of a nested class, forward declared in a template - class, which in turn was in a namespace, caused the variable to end + class, which in turn was in a namespace, caused the variable to end up in the global scope. </li> - + </ul> <h1>Doxygen Release 1.4.4</h1> @@ -5680,7 +5850,7 @@ make sure you add the following: <h3>New features</h3> <ul> <li> Added support for parsing Python code. - Special comment blocks in Python are of the + Special comment blocks in Python are of the <pre> ## # Some comment @@ -5697,8 +5867,8 @@ make sure you add the following: <h3>Bug fixes</h3> <ul> <li> id 166254: SORT_BY_SCOPE_NAME didn't work anymore.</li> -<li> id 304380: New argument matching algorithm didn't handle the case - where "const int" needed to be matched against +<li> id 304380: New argument matching algorithm didn't handle the case + where "const int" needed to be matched against "const int a" correctly.</li> <li> id 304435: Superfluous backslash in the makefile caused problems for Japanese locale.</li> @@ -5708,7 +5878,7 @@ make sure you add the following: embedded doxytag that include the end of a HTML comment.</li> <li> id 304623: Spreading a @fn command over multiple lines didn't work anymore without using line-continuation characters.</li> -<li> id 304666: Attributes of the same class appeared separated with \n in +<li> id 304666: Attributes of the same class appeared separated with \n in collaboration diagrams</li> <li> id 304751: A define "foo()" was indistinguishable from a define "foo" in the XML output.</li> @@ -5732,15 +5902,15 @@ make sure you add the following: next paragraph.</li> <li> id 305770: For overloaded global functions only the first appeared in the file documentation.</li> -<li> id 306028: The text after /*@{ and //@{ was treated as source code +<li> id 306028: The text after /*@{ and //@{ was treated as source code instead of a comment block.</li> <li> id 306136: Structural commands were executed even though they appeared within quoted text.</li> <li> id 306200: Putting a command like \author before \brief caused the long description to be glued to the \author command.</li> -<li> id 306235: Punctuation is not automatically added to brief +<li> id 306235: Punctuation is not automatically added to brief descriptions for Japanese, Chinese, and Korean anymore. </li> -<li> id 306637: @endcond did not properly end a conditional section +<li> id 306637: @endcond did not properly end a conditional section when @cond was used without label.</li> <li> id 306711: Brief descriptions ended at a new paragraph even if no content was found and @name didn't work without explicit @@ -5757,7 +5927,7 @@ make sure you add the following: documented with \var and also had a brief description.</li> <li> id 307954: Parse problem when a /* was nested inside a C-style comment.</li> <li> id 308053: It is now possible to put multiple structural commands into - a single comment block. Doxygen will treat them as + a single comment block. Doxygen will treat them as separate comment blocks internally. Example: <pre> /** @file @@ -5766,11 +5936,11 @@ make sure you add the following: * Group documentation. */ </pre></li> -<li> id 308059: &nbsp; was written as "\ " to the LaTeX output instead +<li> id 308059: &nbsp; was written as "\ " to the LaTeX output instead of ~.</li> <li> id 308400: The parameter names are now used based on whether the documentation is in front of the declaration or definition.</li> -<li> id 309022: Conversion operators inherited from a template class +<li> id 309022: Conversion operators inherited from a template class did not appear with the proper type substitution.</li> <li> id 309148: The search index page was not correct if DISABLE_INDEX was set to YES.</li> @@ -5780,7 +5950,7 @@ make sure you add the following: <li> id 309711: Aliases were expanded inside formulas.</li> <li> id 310012: Made the allowed suffixes for constants in the constant expression evaluator of the C-preprocessor more strict.</li> -<li> id 310025: Added explicit type conversion to avoid problems with +<li> id 310025: Added explicit type conversion to avoid problems with compiler bugs in Sun's Forte 6.1 and Studio 10 compiler.</li> <li> Fixed argument matching issue exposed by the template example in the examples directory.</li> @@ -5791,9 +5961,9 @@ make sure you add the following: <a name="1.4.3"></a> <h3>Changes</h3> <ul> -<li> For Developers: Added an abstract interface for language parsers - (see src/parserintf.h), which can be used implement new programming - language parsers. There is also a manager class, where a parser +<li> For Developers: Added an abstract interface for language parsers + (see src/parserintf.h), which can be used implement new programming + language parsers. There is also a manager class, where a parser instance can be bound to a certain file extension.</li> <li> Changed the algorithm for matching function/method declarations against their definitions. The new algorithm should be faster, more powerful, @@ -5802,8 +5972,8 @@ make sure you add the following: <h3>New features</h3> <ul> -<li> Included new config option HTAGS. When enabled in combination with - SOURCE_BROWSER=YES, the source browser of GNU's Global source +<li> Included new config option HTAGS. When enabled in combination with + SOURCE_BROWSER=YES, the source browser of GNU's Global source system (via htags) is used instead of doxygen's own (thanks to Shigio Yamaguchi for the patch).</li> <li> Added language updates for Indonesian, Catalan, Russian, Korean, @@ -5813,20 +5983,20 @@ make sure you add the following: <h3>Bug fixes</h3> <ul> -<li> id 163705: Using \image for latex without caption but with size +<li> id 163705: Using \image for latex without caption but with size parameter "width=\textwidth" did not work.</li> -<li> id 163783: Items of an autolist could be wrongly indented if put +<li> id 163783: Items of an autolist could be wrongly indented if put directly after @name.</li> <li> id 163928: Class section was missing in the file documentation.</li> <li> id 164072: When using tag files unneeded external classes could appear in the class hierarchy in some cases.</li> -<li> id 169755: page title was omitted in the XML output if +<li> id 169755: page title was omitted in the XML output if CASE_SENSE_NAME was set to NO.</li> <li> id 170592: Using \ref for Objective-C methods did not work if the name contained a colon.</li> <li> id 171795: Referring to Objective-C methods now follows Apple's conventions. </li> -<li> id 171878: When JAVADOC_AUTOBRIEF = YES and there was no blank line +<li> id 171878: When JAVADOC_AUTOBRIEF = YES and there was no blank line after a page command, the first sentence did not appear in the documentation.</li> <li> id 171923: Doxygen failed to match arguments for a function documented @@ -5834,14 +6004,14 @@ make sure you add the following: <li> id 172118: Doxywizard now shows the version of doxygen it is for.</li> <li> id 172133: Doxygen did not longer ignore preceding C++ comments inside a comment block.</li> -<li> id 172217: 'using namespace' declarations with spaces resulted +<li> id 172217: 'using namespace' declarations with spaces resulted in duplicate namespaces.</li> <li> id 172329: The index of the CHM did not always link to groups correctly.</li> -<li> id 172456: Fixed case where doxygen had problems differentiating const +<li> id 172456: Fixed case where doxygen had problems differentiating const and non-const member functions.</li> -<li> id 172494: @code blocks were not properly ignored by the preprocessor +<li> id 172494: @code blocks were not properly ignored by the preprocessor in some cases.</li> -<li> id 172622: Fixed parse problem for Objective-C method implementations +<li> id 172622: Fixed parse problem for Objective-C method implementations whole declaration part ended with a semicolon.</li> <li> id 172723: Namespace members appeared in the file documentation without proper links to the namespace.</li> @@ -5856,47 +6026,47 @@ make sure you add the following: <li> id 300204: Doxygen disobeyed Cygwin's 'text/binary mount mode' (thanks to Max Bowsher for the patch).</li> <li> id 300466: Improved the documentation for FILTER_SOURCE_FILES.</li> -<li> is 300473: Added a browse button for several of Doxywizard's +<li> is 300473: Added a browse button for several of Doxywizard's fields of the expert dialog where a file was expected.</li> <li> id 300532: consecutive @todo items were joined together even if they are in different sections.</li> <li> id 300745: A disabled @cond section did not omit #define documentation.</li> <li> is 301409: autolinks to undocumented files did not work correctly when SOURCE_BROWSER was enabled.</li> -<li> id 301437: Fixed a typo in an example that is part of the preprocessor +<li> id 301437: Fixed a typo in an example that is part of the preprocessor documentation.</li> <li> id 301478: Fixed some cases where cross-references were not properly detected anymore.</li> <li> id 301616: Added "+" or "-" to the Objective-C method lists in the summary section of a class.</li> -<li> id 302100: An enum could not be grouped by grouping out of line +<li> id 302100: An enum could not be grouped by grouping out of line documentation.</li> <li> id 302158: When enabling SEPARATE_MEMBER_PAGES and CREATE_SUBDIRS the member index contained invalid links.</li> <li> id 302160: list directly after @brief not parsed properly if there were spaces before the @brief command.</li> -<li> id 302713: Updated doxytag so it works better with recent versions +<li> id 302713: Updated doxytag so it works better with recent versions of Qt3 and the Qt4 beta versions.</li> -<li> id 303305: When using \subpage the page hierarchy wasn't reflected +<li> id 303305: When using \subpage the page hierarchy wasn't reflected in the tree view or .chm index.</li> -<li> id 303511: Documenting a class in a namespace with a comment block +<li> id 303511: Documenting a class in a namespace with a comment block inside the namespace containing a @class command did not work properly.</li> -<li> id 303911: Links from todo list items to Objective-C categories were +<li> id 303911: Links from todo list items to Objective-C categories were broken.</li> <li> id 304026: A class/struct/interface can now be turned into something - else of the same kind using the proper command (i.e. + else of the same kind using the proper command (i.e. @interface could by used to turn a class into an interface).</li> -<li> Doxygen did not honor the "All members of an interface in Java are +<li> Doxygen did not honor the "All members of an interface in Java are implicitly public" rule.</li> -<li> An enum of a class could not be documented with @enum from inside a +<li> An enum of a class could not be documented with @enum from inside a namespace.</li> <li> Fixed problem handling unname member groups (useful in combination with DISTRIBUTE_GROUP_DOC = YES, which didn't work anymore).</li> <li> Updated Doxygen.dsp (thanks to Gerik Rhoden).</li> -<li> For a word marked with a #, the # is now also removed when no link +<li> For a word marked with a #, the # is now also removed when no link could be generated.</li> -<li> Using '<' (or '\<') in a <pre> section cause '$<$' +<li> Using '<' (or '\<') in a <pre> section cause '$<$' to appear in the Latex output.</li> </ul> @@ -5908,9 +6078,9 @@ make sure you add the following: <li>If the class/namespace/file member indexes get too long they are now automatically split over multiple pages (one page per index letter).</li> <li>Internal: I've split the input scanner (scanner.l) in a part that scans - the supported programming languages and passes the comment blocks to a + the supported programming languages and passes the comment blocks to a second scanner. This should clean up the code a lot and make - the handling of structural commands (like \class and \section) + the handling of structural commands (like \class and \section) more consistent. It is also a first step towards supporting dedicated scanners for other programming languages. </li> <li>Made doxygen parse .as files (Action Script) as Java code.</li> @@ -5923,10 +6093,10 @@ make sure you add the following: all members on the class/file/namespace page. An index for other members of the same compound is rendered on the left hand side of the page.</li> <li>Added new command \subpage that can be used to build a hierarchy of - pages. For pages this is more convenient than using \defgroup + pages. For pages this is more convenient than using \defgroup and \ingroup. See the documentation more details and an example.</li> <li>Included man pages for doxygen and doxywizard.</li> -<li>Language updates for Czech, Swedish, Russian, Italian, Catalan, +<li>Language updates for Czech, Swedish, Russian, Italian, Catalan, German, Brazilian, Korean, Ukrainian, Romanian, Croatian and Chinese,</li> </ul> @@ -5937,45 +6107,45 @@ make sure you add the following: <li>id 142339: Doxygen did not using the LATEX_CMD_NAME setting when generating formulas.</li> <li>id 163180: Extension specific filters did not work.</li> -<li>id 163940: Labels in dot graphs containing quotes where +<li>id 163940: Labels in dot graphs containing quotes where not escaped properly.</li> <li>id 164198: \overload text was always English, it is now translatable.</li> -<li>id 164498: Fixed problem where doxygen ignored the documentation for - members of Objective C class categories when put in the +<li>id 164498: Fixed problem where doxygen ignored the documentation for + members of Objective C class categories when put in the implementation section.</li> <li>id 164563: \anchor didn't work inside a <pre>...</pre> section.</li> <li>id 164812: fix compile problem for certain language selections.</li> <li>id 165097: Fixed problem with wrong syntax color in \code section.</li> -<li>id 165188: in index.xsd the refid attribute type (xsd:Name) was +<li>id 165188: in index.xsd the refid attribute type (xsd:Name) was not broad enough and has been replaced by xsd:string.</li> -<li>id 165339: Fixed some issues in the code parser causing missed +<li>id 165339: Fixed some issues in the code parser causing missed cross-referencing relations and/or call graphs.</li> -<li>id 165428: ALIASES containing @section commands where not +<li>id 165428: ALIASES containing @section commands where not handled properly.</li> <li>id 165503: grouped classes did not appear as such in the XML output.</li> <li>id 165793: input filter was applied to \verbinclude.</li> <li>id 165816: Grouped functions referenced via tag files had broken links</li> <li>id 165821: Tag file parser produced bogus errors for nested classes and namespaces and no line number was reported.</li> -<li>id 166043: static initializer block in Java made doxygen ignore the +<li>id 166043: static initializer block in Java made doxygen ignore the rest of the file.</li> <li>id 166161: More documentation to make the \code command more clear.</li> -<li>id 166756: Fixed a number of issues with the new comment scanner. +<li>id 166756: Fixed a number of issues with the new comment scanner. It should be much more usable now.</li> -<li>id 166782: XML output: Simple types in a namespace are also +<li>id 166782: XML output: Simple types in a namespace are also listed at file scope in index.xml</li> <li>id 166863: @class required fully qualified name even if the comment block was in the right scope already.</li> -<li>id 166898: Forward declaring a template class added the template +<li>id 166898: Forward declaring a template class added the template argument to next class defined</li> -<li>id 167037: The method names were non-informative in the todo like +<li>id 167037: The method names were non-informative in the todo like lists when HIDE_SCOPE_NAMES was set to YES (thanks to Luigi Ballabio for the fix).</li> <li>id 167040: Related functions were listed as members in the todo list.</li> -<li>id 167462: Doxygen doesn't recognize references to methods of classes +<li>id 167462: Doxygen doesn't recognize references to methods of classes that come as parameter</li> <li>id 168159: Sometimes enums don't have hyperlinks in the source code.</li> -<li>id 168243: Doxygen produced an unclear warning when putting multiple +<li>id 168243: Doxygen produced an unclear warning when putting multiple @page commands in one comment block.</li> <li>id 168693: A C-style comment ending with a brief description (including dot) and a **/ as end marker, caused strange warning.</li> @@ -5984,14 +6154,14 @@ make sure you add the following: <li>id 168871: \~ did not work in C++ style documentation and aliases.</li> <li>id 168961: Fixed problem parsing arrays of unnamed structs.</li> <li>id 169003: cross-references were make to global variables even if the - global variables were hidden by local ones or + global variables were hidden by local ones or undocumented/private member variables.</li> -<li>id 169069: static C++ variables with initializers were detected as +<li>id 169069: static C++ variables with initializers were detected as functions.</li> -<li>id 169188: static functions were not extracted from PHP classes even +<li>id 169188: static functions were not extracted from PHP classes even though EXTRACT_STATIC was set to YES.</li> <li>id 169495: const Qt properties were not parsed properly.</li> -<li>id 169535: spaces after \ref command were not preserved +<li>id 169535: spaces after \ref command were not preserved in <pre> context when the command had only one argument.</li> <li>id 169547: Removed bogus warning for friend classes inside classes in an anonymous namespace.</li> @@ -6007,21 +6177,21 @@ make sure you add the following: <li>id 170612: documenting members of nested anonymous compounds did no longer work.</li> <li>id 170833: <code> ended a brief description.</li> -<li>id 170835: doxygen didn't match members of classes in unnamed +<li>id 170835: doxygen didn't match members of classes in unnamed namespaces with their definitions</li> -<li>id 170846: template instance friend classes could not be documented +<li>id 170846: template instance friend classes could not be documented externally. </li> -<li>id 171260: In some cases doxygen produced an incorrect warning about +<li>id 171260: In some cases doxygen produced an incorrect warning about duplicate detailed descriptions.</li> <li>id 171295: It now possible again to link to a (enum)value of a @retval using #name.</li> -<li>id 171376: \else command was not properly parsed if the corresponding +<li>id 171376: \else command was not properly parsed if the corresponding \if was disabled. </li> <li>id 171749: Using @relatesalso for functions in a namespace didn't work correctly.</li> -<li>It is now possible again to use Thing%s to auto-link to a class +<li>It is now possible again to use Thing%s to auto-link to a class Thing and put a non-linked "s" after it.</li> -<li>Nested anonymous namespaces appeared as @<num> in the +<li>Nested anonymous namespaces appeared as @<num> in the documentation of the parent namespace.</li> <li>aliases containing @brief were not handled correctly.</li> <li>The class name in the HtmlHelp index was linked to the @@ -6046,14 +6216,14 @@ make sure you add the following: <a name="1.4.0"></a> <h3>Changes</h3> <ul> -<li> In the HTML help output (.chm files) the index items with only one - subitem are now collapsed into one item (thanks to Antony Pranata for +<li> In the HTML help output (.chm files) the index items with only one + subitem are now collapsed into one item (thanks to Antony Pranata for the patch).</li> <li> Some minor tweaks to the style sheet.</li> <li> @relates can now not only be used for functions, but also for other members (i.e. enums, types and variables).</li> -<li> Static members do have have explicit "static" in the declaration - part of the documentation. This is useful for grouping where it +<li> Static members do have have explicit "static" in the declaration + part of the documentation. This is useful for grouping where it is otherwise not obvious that a member is static.</li> <li> typedefs and enumeration are no longer shown in the "referenced by" list as these are types (based on patch by Antoine Tandin). </li> @@ -6065,13 +6235,13 @@ make sure you add the following: <li> Included language update for Serbian, German, and Korean.</li> <li> For directories dependency graphs are now generated (controlled by the DIRECTORY_GRAPH switch). For a given directory, the graph will - show its parent directory and the sub directories as nested boxes. - For the directory and its sub directories it will show the relations - with other directories. Relations are based on #include relations of - the files contained in the directories. Each dependency arrow has an - associated number. This number indicates the number of - different #include relations. Clicking on the number will show a page - with the exact #include relations (the latter is for the HTML output + show its parent directory and the sub directories as nested boxes. + For the directory and its sub directories it will show the relations + with other directories. Relations are based on #include relations of + the files contained in the directories. Each dependency arrow has an + associated number. This number indicates the number of + different #include relations. Clicking on the number will show a page + with the exact #include relations (the latter is for the HTML output only). </li> <li> Added \cond and \endcond commands, which can be used to (conditionally) exclude a part of a file. See the manual for an @@ -6082,19 +6252,19 @@ make sure you add the following: parameter or return type documentation.</li> <li> Nested classes are now listed in their containing class.</li> <li> Extended the \f command to support different environments, i.e. - \f{eqnarray*} for equation arrays. The end command is \f}. The + \f{eqnarray*} for equation arrays. The end command is \f}. The documentation has an example.</li> -<li> Added support for group dependency graphs +<li> Added support for group dependency graphs (thanks to a patch by Antoine Tandin): New option: GROUP_GRAPHS</li> <li> New option DOT_TRANSPARENT to enable dot graph with a transparent background. Thanks to Maik Hinrichs for the patch.</li> <li> New option FILE_VERSION_FILTER which allows an external tool to provide version information per file, which is then used in the file documentation. Thanks to Maik Hinrichs for the patch.</li> -<li> id 162295: New option DOT_MULTI_TARGETS which when set to YES, - will run dot with multiple output files if possible. This was added - to support older version of dot (<=1.8.10) which do not support multiple - output targets. If you use a recent version of dot, you probably want +<li> id 162295: New option DOT_MULTI_TARGETS which when set to YES, + will run dot with multiple output files if possible. This was added + to support older version of dot (<=1.8.10) which do not support multiple + output targets. If you use a recent version of dot, you probably want to enable this (default is NO).</li> </ul> <h3>Bug fixes</h3> @@ -6105,29 +6275,29 @@ make sure you add the following: operation like \cond.</li> <li> id 135311: Recursive ALIAS definitions now work again.</li> <li> id 151012: <td> tag in HTML function documentation missed 'class="md"'</li> -<li> id 154689: Wrong link to members of namespaces imported from tag +<li> id 154689: Wrong link to members of namespaces imported from tag files when CASE_SENSE_NAMES is set to NO.</li> <li> id 154700: anchors in pages imported via tag files could not be linked to.</li> <li> id 154755: Files were missing from Doxygen.dsp project file. (thanks to Gerik Rhoden).</li> -<li> id 154758: Fixed typedef resolution bug that could crash doxygen +<li> id 154758: Fixed typedef resolution bug that could crash doxygen (thanks to Gerik Rhoden for the analysis and fix).</li> -<li> id 154862: Fixed problem matching array parameters that include +<li> id 154862: Fixed problem matching array parameters that include template parameters as the array size.</li> <li> id 154863: Fixed parsing problem in the preprocessor when an expression contained the division operator.</li> <li> id 154469: Referring to Objective-C messages was broken if the full scope was used.</li> -<li> id 155086: Typedef for member-function pointers of template classes +<li> id 155086: Typedef for member-function pointers of template classes not recognized</li> <li> id 155272: Image filenames in RTF output were not quoted causing problem with custom images whose name contained spaces.</li> <li> id 155322: Fixed parse problem for php code containing '#'. </li> <li> id 155224: Java interfaces didn't resolve across packages w/o FQN.</li> -<li> id 156411: Return type of a function was not hyperlinked in some cases +<li> id 156411: Return type of a function was not hyperlinked in some cases (typical with nested namespaces or Java packages).</li> -<li> id 156445: function seen first in header and doc'ed in +<li> id 156445: function seen first in header and doc'ed in source broke autolinking depending on the order of the input.</li> <li> id 157085: Autolinks for const/volatile operators didn't work.</li> <li> id 157229: Upper case letters in \page "<name>" breaks title on page.</li> @@ -6137,14 +6307,14 @@ make sure you add the following: <li> id 158961: Set EXTRACT_ALL to NO resulted in no directory information unless the directory and files were documented. This is now controlled by SHOW_DIRECTORIES.</li> -<li> id 158481: I did some memory usage analysis with valgrind's massif tool, - which indicated that a lot of memory was used by QCString objects. - This made me decide to reimplement the class and optimize it for - memory usage. The resulting class saves a "new" operation of 12 bytes - per string object, which seems to reduce the overall amount of - memory used by doxygen by a factor 2 to 3! The implementation seemed +<li> id 158481: I did some memory usage analysis with valgrind's massif tool, + which indicated that a lot of memory was used by QCString objects. + This made me decide to reimplement the class and optimize it for + memory usage. The resulting class saves a "new" operation of 12 bytes + per string object, which seems to reduce the overall amount of + memory used by doxygen by a factor 2 to 3! The implementation seemed more expense to use (as it always copies the content instead of sharing - it), but the performance has improved nevertheless (probably because + it), but the performance has improved nevertheless (probably because "new" is much more expensive operation than copying small strings).</li> <li> id 158637: Links to classes in brief description in index pages were wrong when CREATE_SUBDIRS was set to YES.</li> @@ -6154,14 +6324,14 @@ make sure you add the following: <li> id 160642: Fixed problem parsing multi-dimensional C arrays.</li> <li> id 160673: Borland's __property keyword was not handled correctly.</li> <li> id 160824: UML Collab diagram did't show fields in user defined groups.</li> -<li> id 160931: Made configure script use /bin/bash as it apparently didn't +<li> id 160931: Made configure script use /bin/bash as it apparently didn't work with /bin/sh anyway.</li> -<li> id 161048: Latex output for directories could contain unescaped +<li> id 161048: Latex output for directories could contain unescaped underscores when SHOW_DIRECTORIES was set to YES.</li> <li> id 161167: /// \file was not parsed properly.</li> <li> id 161247: If CALL_GRAPH was enabled references were shown even if REFERENCES_RELATION was set to NO.</li> -<li> id 161320: An incorrect line number was given for inherited comments +<li> id 161320: An incorrect line number was given for inherited comments which have an error.</li> <li> id 161321: Fixed problem parsing '"' in PHP code.</li> <li> id 161394: Fixed problem with inheritance tree showing the same @@ -6172,7 +6342,7 @@ make sure you add the following: <li> id 162434: void function gave rise to warnings when WARN_NO_PARAMDOC was set to YES.</li> <li> id 162446: Fixed parse problem in code.l, causing it to get off track.</li> -<li> id 162517: A @ref command was not parsed properly if the argument +<li> id 162517: A @ref command was not parsed properly if the argument between quotes was found on the next line.</li> <li> Dot would not run if doxygen was installed in a path which contained spaces (Mac OS X).</li> @@ -6191,12 +6361,12 @@ make sure you add the following: <li> Fixed a couple of memory leaks.</li> <li> Fixed crash problem on Windows related to the new string implementation.</li> <li> Fixed problem with Visual Studio project files (in wintools).</li> -<li> Included patch by Antoine Tandin to fix problem with GROUP_GRAPHS +<li> Included patch by Antoine Tandin to fix problem with GROUP_GRAPHS in combination with CREATE_SUBDIRS = YES.</li> <li> Included patch by Mikhail Glushenkov to make HTML look prettier.</li> <li> Parsing operator[]s was broken.</li> <li> Referencing constants via #CONST did not work anymore.</li> -<li> Fixed problem handing multiline ALIASES containing @defgroup and +<li> Fixed problem handing multiline ALIASES containing @defgroup and @ingroup.</li> <li> Fixed problem handling \n in ALIASES.</li> <li> @section's in non-page documentation blocks did not work.</li> @@ -6211,21 +6381,21 @@ make sure you add the following: <h1>Doxygen Release 1.3.9.1</h1> <h3>Bug fixes</h3>(ids refer to the old bugzilla issue, just use it in the search box of the <a href="https://github.com/doxygen/doxygen/issues">issue tracker</a>)<br/> <ul> -<li> Due to an error in the packaging script, an old version of doxywizard +<li> Due to an error in the packaging script, an old version of doxywizard was bundled with the Mac OS X version of doxygen.</li> <li> Dot would not run if doxygen was installed in a path which contained spaces (Mac OS X).</li> -<li> id 151012: <td> tag in HTML function documentation +<li> id 151012: <td> tag in HTML function documentation missed 'class="md"'</li> -<li> id 154689: Wrong link to members of namespaces imported from tag +<li> id 154689: Wrong link to members of namespaces imported from tag files when CASE_SENSE_NAMES is set to NO.</li> <li> id 154700: anchors in pages imported via tag files could not be linked to.</li> <li> id 154755: Files were missing from Doxygen.dsp project file. (thanks to Gerik Rhoden for sending an update).</li> -<li> id 154758: Fixed typedef resolution bug that could crash doxygen +<li> id 154758: Fixed typedef resolution bug that could crash doxygen (thanks to Gerik Rhoden for the analysis and fix).</li> -<li> id 154862: Fixed problem matching array parameters that include +<li> id 154862: Fixed problem matching array parameters that include template parameters as the array size.</li> <li> id 154863: Fixed parsing problem in the preprocessor when an expression contained the division operator.</li> @@ -6241,8 +6411,8 @@ make sure you add the following: <li> id 149899: A macro defined in the config file (see PREDEFINED) can now prevented from being undefined (via a #undef in the code) when its value is assigned via the := operator (e.g. PREDEFINED = A(x):=x ).</li> -<li> id 150631: if HIDE_SCOPE_NAMES is enabled the scope of a method in a - call graph is only shown when the method is of a different +<li> id 150631: if HIDE_SCOPE_NAMES is enabled the scope of a method in a + call graph is only shown when the method is of a different class.</li> <li> id 151911: Stylesheet is generated earlier in the process.</li> <li> id 152164, 152166: Improved the way search results are sorted.</li> @@ -6251,17 +6421,17 @@ make sure you add the following: </ul> <h3>New features</h3> <ul> -<li> Directory information is now extracted by doxygen. Files are - automatically grouped by directory. You can use +<li> Directory information is now extracted by doxygen. Files are + automatically grouped by directory. You can use the SHOW_DIRECTORIES option to enable/disable this feature. Added a new command \dir which can be used to document directories.</li> -<li> Language updates for Czech, Swedish, Hungarian, Danish, Russian, Italian, +<li> Language updates for Czech, Swedish, Hungarian, Danish, Russian, Italian, German, Chinese, Croatian, and Polish.</li> <li> Applied a patch by Arend van Beelen which adds support for the new features introduced in PHP5.</li> -<li> Applied a patch by Ferdinand Wess for better handling of #import +<li> Applied a patch by Ferdinand Wess for better handling of #import statements in Obj-C code.</li> -<li> Applied a patch by Adam Treat to add read and write accessors +<li> Applied a patch by Adam Treat to add read and write accessors of a Q_PROPERY to the XML output.</li> <li> Arnaud Bercegeay has added platform support for the Atari MiNT OS. </li> <li> Included patch by James Ahlborn which improves the way nested numbered @@ -6279,24 +6449,24 @@ make sure you add the following: <li> id 126344: Added initial support for member template specializations.</li> <li> id 126448: Argument passed to input filter was not always quoted.</li> <li> id 126745: Anchors of grouped members were wrong in some cases.</li> -<li> id 128585: Lists were not always rendered properly in the man page +<li> id 128585: Lists were not always rendered properly in the man page output format.</li> <li> id 128809: Hidden files (starting with a dot) could not be included with for instance \verbinclude.</li> -<li> id 130431: Prevented recursive loop in the call graph when a function +<li> id 130431: Prevented recursive loop in the call graph when a function declares a local variable with the name of the function.</li> <li> id 131299: \copydoc with argument A#func() didn't work.</li> -<li> id 131354: Fixed bug matching function declaration/implementation with +<li> id 131354: Fixed bug matching function declaration/implementation with using declarations.</li> -<li> id 135448: Improved autodetection of Qt by the configure script +<li> id 135448: Improved autodetection of Qt by the configure script some more (thanks to Michael Henry).</li> <li> id 135808: Removed reference to doxysearch.cpp from Doxyfile included with the source distribution.</li> -<li> id 138629: Included patch to make the HTML output more conformant to +<li> id 138629: Included patch to make the HTML output more conformant to the XHTML standard (thanks to Jan Nijtmans).</li> <li> id 144865: Variables in anonymous unions/structs did not appear as data fields.</li> -<li> id 148547: Added a workaround for a compile problem in pngrutils.c +<li> id 148547: Added a workaround for a compile problem in pngrutils.c on AIX 5.2.</li> <li> id 148671: Using "publicsomething" as a name for a base class resulted in the "public" part being stripped.</li> @@ -6304,44 +6474,44 @@ make sure you add the following: <li> id 149023: Fixed template inheritance through typedefs problem.</li> <li> id 149045: Fixed several small problems related to template handling.</li> <li> id 149106: Fixed problem parsing enum declarations.</li> -<li> id 149164: Fixed problem in the configure script when used with perl +<li> id 149164: Fixed problem in the configure script when used with perl version 5.6 (thanks to a patch by Joerg Schlichenmaier)</li> <li> id 149258: Example sources could be wrongly indented.</li> <li> id 149263: Fixed copy/paste error in HTML_FOOTER documentation.</li> <li> id 149698: Multiple lines of //!< comments were not handle correctly.</li> <li> id 149711: Title of a namespace page/section was not generated.</li> <li> id 149797: Forgot to turn off debug mode for the RTF output.</li> -<li> id 149880: Brief description of one variable could appear in the +<li> id 149880: Brief description of one variable could appear in the the description of the next under certain circumstances.</li> <li> id 150264: linking to Obj-C protocols did not work.</li> -<li> id 150427: "virtual" and "const" were not nicely formatted when +<li> id 150427: "virtual" and "const" were not nicely formatted when followed by unary scope resolution operator (e.g "const ::A")</li> <li> id 150629: Enabling OPTIMIZE_OUTPUT_JAVA did not help for call graphs.</li> <li> id 151457: Fixed compile problem on Solaris 4.2.</li> -<li> id 151452: Bug in LaTeX output for anonymous structs/unions whose +<li> id 151452: Bug in LaTeX output for anonymous structs/unions whose members have brief descriptions.</li> <li> id 151246: Parse error when using in-body comment blocks.</li> <li> id 152005: Objective-C string constants appear in output with @"@"</li> <li> id 152182: Spaces mess up type in Objective C functions.</li> -<li> id 152184: label-less parameters in Objective C functions were not +<li> id 152184: label-less parameters in Objective C functions were not parsed properly.</li> <li> id 152383: Objective-C categories showed methods twice.</li> <li> id 152572: \brief inside an argument description caused a bogus warning.</li> -<li> id 152681: Call-graphs were generated inside a table environment in +<li> id 152681: Call-graphs were generated inside a table environment in the HTML output.</li> <li> #include after a @file comment made the #include appear on the same line when DETAILED_AT_TOP was enabled.</li> -<li> User specified images & stylesheets did not work with +<li> User specified images & stylesheets did not work with CREATE_SUBDIR.</li> <li> Nested using directives did not work for C#.</li> <li> Grouped classes did not always appear in the modules section of the navigation tree.</li> <li> "internal" classes appeared in the XML output.</li> -<li> friend classes did no longer appear in the output even when +<li> friend classes did no longer appear in the output even when HIDE_FRIEND_COMPOUNDS was set to NO.</li> <li> Fixing bug in code parser when encountering arrays and some other related problems.</li> -<li> Array initializers did not show up regardless of the +<li> Array initializers did not show up regardless of the MAX_INITIALIZER_LINES setting.</li> <li> Improved support for classes with the same name but in different namespaces in combination with "using" of namespaces.</li> @@ -6362,17 +6532,17 @@ make sure you add the following: </ul> <h3>New features</h3> <ul> -<li> New option FILTER_PATTERNS which can be used to specify multiple +<li> New option FILTER_PATTERNS which can be used to specify multiple input filters, and let doxygen select the right one based on matching the source file name with a specified pattern (thanks to a patch by James Ahlborn).</li> <li> id 142939: New commands \protocol and \category which can be used - to document Objective-C protocols and categories in the same way + to document Objective-C protocols and categories in the same way the \class command does for classes.</li> -<li> Included patch that removes some cosmetic annoyances in the man page +<li> Included patch that removes some cosmetic annoyances in the man page output (thanks to Chris Croughton).</li> <li> Added internationalization support for Afrikaans and - Lithuanian. Included language updates for Dutch, + Lithuanian. Included language updates for Dutch, Czech, Italian, Brazilian, Croatian, Japanese, Norwegian and Russian.</li> </ul> @@ -6386,9 +6556,9 @@ make sure you add the following: <li> id 138075: A comment block containing a \code block with C style comments was not properly parsed.</li> <li> id 138307: Fixed parse problems with single quoted strings in PHP.</li> -<li> id 138394: C style comments placed on the same line after a macro +<li> id 138394: C style comments placed on the same line after a macro definition appeared as part of the macro's value.</li> -<li> id 138429: Fixed language setting for HTML output when using +<li> id 138429: Fixed language setting for HTML output when using traditional Chinese.</li> <li> id 140259: Using @dotfile in a comment block could cause broken @refs to sections defined after the @dotfile command.</li> @@ -6397,13 +6567,13 @@ make sure you add the following: <li> id 142118: Fixed compile issue with the mingw compiler.</li> <li> id 142288: Doxywizard crashed when started (fix was applied to version 1.3.7 as well).</li> -<li> id 142741: Links in todo/bug/... lists were broken if CREATE_SUBDIRS +<li> id 142741: Links in todo/bug/... lists were broken if CREATE_SUBDIRS was enabled. Same was true for the built-in diagrams.</li> -<li> id 142925: Autolinking to a member of a class from a page inside a +<li> id 142925: Autolinking to a member of a class from a page inside a namespace did not work.</li> -<li> id 142940: Due to a misplaced break statement a examples included +<li> id 142940: Due to a misplaced break statement a examples included with \example was shown twice in the output.</li> -<li> id 143107: Made some cosmetic changes to the HTML and HTML output, +<li> id 143107: Made some cosmetic changes to the HTML and HTML output, (thanks to David Baird for the patch).</li> <li> id 143340: Fixed autolink problem for names ending with a colon or a <br> tag.</li> @@ -6418,21 +6588,21 @@ make sure you add the following: code parser.</li> <li> id 147425: The class diagram did not show the relation to the template specialization when inheritance was done via one or more typedefs.</li> -<li> Fixed case where template classes "used" via typedefs were not +<li> Fixed case where template classes "used" via typedefs were not properly shown in the collaboration diagram.</li> <li> Variables explicitly declared external were reported being defined at the place they were actually declared external.</li> <li> Fixed bug in the XML schema for enum values with initializers.</li> <li> Documentation of a member group did not appear in the XML output (thanks to Chris Croughton for the patch).</li> -<li> Command line build process failed under windows if the name of the - directory in which sources are located contained spaces (thanks to +<li> Command line build process failed under windows if the name of the + directory in which sources are located contained spaces (thanks to Mikhail Glushenkov for the patch).</li> <li> Improved cross-referencing to methods of a template instance variables (thanks to a patch by Jeff Apple).</li> <li> Included a patch by Enrico Schnepel that puts the same output files - in the same subdirectories (with SUBDIRS = YES) for subsequent runs - (on slightly modified input files) and also renumbers the dot nodes + in the same subdirectories (with SUBDIRS = YES) for subsequent runs + (on slightly modified input files) and also renumbers the dot nodes so they are only regenerated when actually changed.</li> <li> Unsupported HTML end tags and unsupported begin tags with attributes are now copied to the output as is.</li> @@ -6441,28 +6611,28 @@ make sure you add the following: <h1>Doxygen Release 1.3.7</h1> <h3>Changes</h3> <ul> -<li> The \param command now has an optional input and/or output attribute. - The syntax for an input & output parameter is for example: +<li> The \param command now has an optional input and/or output attribute. + The syntax for an input & output parameter is for example: \param[in,out] name Description.</li> </ul> <h3>New features</h3> <ul> <li> Added new option CREATE_SUBDIRS which when enabled makes doxygen distribute the generated output evenly over 100 subdirectories.</li> -<li> Added support for Qt's properties (i.e. Q_PROPERTY) which can be - documented by putting a documentation block in front of the macro or +<li> Added support for Qt's properties (i.e. Q_PROPERTY) which can be + documented by putting a documentation block in front of the macro or by using a comment block with the new \property command. </li> <li> Added new commands \manonly and \endmanonly to enter man page specific text and commands in the generated man pages (thanks to Carsten Stiborg).</li> -<li> Included new python based translation report script, which now +<li> Included new python based translation report script, which now replaces the old perl based version (thanks to Petr Prikryl).</li> -<li> Improved parser to also support parsing of Objective-C implementation +<li> Improved parser to also support parsing of Objective-C implementation files.</li> <li> Added new config option EXTRACT_LOCAL_METHODS which can be used for Objective-C code to extract methods definition in the implementation section that are not present in the interface.</li> -<li> Added new config option STRIP_FROM_INC_PATH which allows to - specify a list of paths that, if matched, will be striped from the +<li> Added new config option STRIP_FROM_INC_PATH which allows to + specify a list of paths that, if matched, will be striped from the #include statement in the generated documentation of a class.</li> <li> Added new command \includelineno with works as \include except it will add line numbers to the code (thanks to Giancarlo Niccolai for the patch).</li> @@ -6471,15 +6641,15 @@ make sure you add the following: </ul> <h3>Bug fixes</h3> <ul> -<li> id 133388: Fixed problem parsing '"' inside multi-line C++ style +<li> id 133388: Fixed problem parsing '"' inside multi-line C++ style comment blocks</li> -<li> id 134265: Doxygen now outputs unrecognized HTML tags instead of +<li> id 134265: Doxygen now outputs unrecognized HTML tags instead of removing them (thanks to Éric Malenfant for the patch).</li> <li> id 134869: When HIDE_SCOPE_NAMES was set to NO, the methods of an Objective-C class did not have the right name.</li> -<li> id 134876: Fixed problem with forward declaration of a protocol in +<li> id 134876: Fixed problem with forward declaration of a protocol in Objective-C.</li> -<li> id 134647: using a parameter name ending with "const" was not +<li> id 134647: using a parameter name ending with "const" was not accepted by doxygen.</li> <li> id 134639: Fixed parse problem in the preprocessor.</li> <li> id 137398: add \% command to the documentation.</li> @@ -6487,28 +6657,28 @@ make sure you add the following: (thanks to a patch by Joe Schirmer).</li> <li> id 138652: Line numbers for defines with /* */ comments were wrong (thanks to J. Noack for the patch).</li> -<li> id 139591: Fixed problem parsing nested template arguments with +<li> id 139591: Fixed problem parsing nested template arguments with comments.</li> <li> id 140012: a variable could appear in a group twice if it was declared externally somewhere.</li> <li> id 140540: Fixed problem parsing "@" in the source code parser.</li> -<li> id 141133: Spaces were stripped in default arguments such as +<li> id 141133: Spaces were stripped in default arguments such as f(const char *t=" \t")</li> -<li> id 141364: Members of an anonymous nested structure had no brief +<li> id 141364: Members of an anonymous nested structure had no brief comment and no link to the detailed description if available.</li> -<li> Fixed recursive lockup problem that was caused by two or more +<li> Fixed recursive lockup problem that was caused by two or more namespaces using each other (i.e. a cycle in the usage relation).</li> <li> Included patch by Erik Zeek to allow the explicit setting of QTDIR to override the "search for Qt" algorithm in the configure script.</li> <li> Parsing of tag files produced for Objective-C code now works.</li> -<li> Objective-C: Improved hyperlinking of source code, handling of - prototypes and the list of all members of a class now also contains the +<li> Objective-C: Improved hyperlinking of source code, handling of + prototypes and the list of all members of a class now also contains the members of class categories.</li> <li> Third argument of @class was ignored (thanks to Mahadevan for the patch).</li> <li> Fixed problem with collaboration diagrams for template instances whose template parameter list contained qualified scope names (e.g A<B::C>).</li> -<li> Removed bogus warning about undefined documented function for +<li> Removed bogus warning about undefined documented function for classes that were made friends of other classes.</li> <li> Spaces where not preserved for @code block inside a @example block.</li> <li> Undocumented dependency relations where not shown in some cases @@ -6522,7 +6692,7 @@ make sure you add the following: doxywizard using a recent Qt version.</li> <li> Call-graphs were missing if a file name ended with ".C" and K&R function definitions were used.</li> -<li> Improved source code generation performance when there are many +<li> Improved source code generation performance when there are many typedefs with the same name in different scopes.</li> <li> Linking to a section resulted in the wrong label in the XML output.</li> </ul> @@ -6541,7 +6711,7 @@ make sure you add the following: <li> Make a start with adding support for Objective-C. Doxygen can now parse Objective-C header files (including protocols and categories). Thanks to Apple for donating hardware.</li> -<li> Include a patch by Hauke Duden which adds preliminary support for +<li> Include a patch by Hauke Duden which adds preliminary support for the D programming language (see http://www.digitalmars.com/d).</li> <li> C Comments inside #defines are now preserved. This could be useful to document boilerplate code.</li> @@ -6552,10 +6722,10 @@ make sure you add the following: <li> Examples (documented via \example) are now included in the XML output.</li> <li> New option SORT_BRIEF_DOCS which when enabled will list the declaration section of the documentation (with the brief descriptions) - in alphabetical order, instead of declaration order (thanks to + in alphabetical order, instead of declaration order (thanks to Akos Kiss for the patch).</li> <li> Included patch for Hungarian translation (thanks to Akos Kiss) - and for the Serbian language. Added support for mixed Korean/english + and for the Serbian language. Added support for mixed Korean/english (thanks to Jihoon Chung). The translator report script was also updated (thanks to Petr Prikryl)</li> </ul> @@ -6567,9 +6737,9 @@ make sure you add the following: lock-up.</li> <li> id 131404: Fixed problem cross-referencing PHP member functions.</li> <li> id 131434: Clarified confusing warning message.</li> -<li> id 131446: Extra attributes of a <a href> tag (like target) are now +<li> id 131446: Extra attributes of a <a href> tag (like target) are now copied to the HTML output.</li> -<li> id 132535: Fixed problem with generating man page output for groups +<li> id 132535: Fixed problem with generating man page output for groups with brief descriptions.</li> <li> id 132772: Fixed compile problems on HP-UX using acc compiler (thanks to Clyde Gerber).</li> @@ -6579,9 +6749,9 @@ make sure you add the following: was shadowed by a parameter name.</li> <li> id 133986: Attributes of the <img> tag where not written to the HTML output.</li> -<li> id 134123: Fixed problem with multiple arrows between nodes +<li> id 134123: Fixed problem with multiple arrows between nodes in the graphical class hierarchy.</li> -<li> \ref in dot graphs was not working correctly (thanks to +<li> \ref in dot graphs was not working correctly (thanks to Eoin MacDonell for the fix).</li> <li> Grouped pages in the XML output did have the same id as their group.</li> <li> Fixed problem handling environment variables inside a @@ -6597,23 +6767,23 @@ make sure you add the following: <h1>Doxygen Release 1.3.5</h1> <h3>Changes</h3> <ul> -<li> Doxygen now only regenerates a dot image if it has actually changed! - This could significantly reduce the time of any run after the first. - Checking if a graph has changed is done by computing an md5 hash for - the graph description which is then stored along with the +<li> Doxygen now only regenerates a dot image if it has actually changed! + This could significantly reduce the time of any run after the first. + Checking if a graph has changed is done by computing an md5 hash for + the graph description which is then stored along with the image generated by dot and compared in subsequent runs.</li> <li> Improved the way lists look in the man pages (thanks to Silke Reimer).</li> </ul> <h3>New features</h3> <ul> -<li> Added support for parsing K&R style function prototypes. - Please try it on your favorite legacy C project and report any +<li> Added support for parsing K&R style function prototypes. + Please try it on your favorite legacy C project and report any problems.</li> -<li> Included languages updates for Traditional Chinese, +<li> Included languages updates for Traditional Chinese, Danish, German, Korean translation.</li> -<li> id 120464: doxygen's XML output does now assign a prot="..." +<li> id 120464: doxygen's XML output does now assign a prot="..." attribute for nested classes (thanks to Paul Ross for the patch).</li> -<li> Added new configuration switch XML_PROGRAMLISTING to enable/disable +<li> Added new configuration switch XML_PROGRAMLISTING to enable/disable generating source code listings as part of the XML output (thanks to Paul Ross for the patch). </li> <li> Added new config option ABBREVIATE_BRIEF which makes the @@ -6621,9 +6791,9 @@ make sure you add the following: independent (thanks to Jake Colman for the patch).</li> <li> The alphabetical class list now comes with a quick index (thanks to Marcin Zukowski for the patch).</li> -<li> An XSLT script "combine.xslt" is now generated in the XML output +<li> An XSLT script "combine.xslt" is now generated in the XML output directory. It can be used to combine XML files into one big file.</li> -<li> The source code is now indexed and thus searchable when the source +<li> The source code is now indexed and thus searchable when the source browser and search engine options are enabled.</li> <li> Added "dist" target to the makefile (thanks to Erik Zeek)</li> </ul> @@ -6639,13 +6809,13 @@ make sure you add the following: was produced.</li> <li> id 123206: Fixed problem in qtools when opening files in text mode.</li> <li> id 123322: The search page did not honor DISABLE_INDEX.</li> -<li> id 123420: Functions with a brief description caused bogus </em> tags +<li> id 123420: Functions with a brief description caused bogus </em> tags in the HTML output.</li> <li> id 124114: typo in the generated PHP search script could cause errors in the search result page.</li> -<li> id 124187: Setting EXTRACT_LOCAL_CLASSES to NO, could result in a +<li> id 124187: Setting EXTRACT_LOCAL_CLASSES to NO, could result in a broken "More..." link in documented local classes inside a namespace.</li> -<li> id 124214: Fixed problem in search indexer, which could crash doxygen +<li> id 124214: Fixed problem in search indexer, which could crash doxygen (thanks to Daniel Koebbing for the patch).</li> <li> id 124545: fixed a number of problems in the generated search script.</li> <li> id 124815: Fixed compile problem in filedef.h for aCC on HP-UX.</li> @@ -6664,14 +6834,14 @@ make sure you add the following: <li> Links to classes, files, namespaces and groups in the search results were broken (missing file extension).</li> <li> Doxygen logo is now transparent even when viewed with IE.</li> -<li> Using a character with ascii code 0x06 in a comment block could crash +<li> Using a character with ascii code 0x06 in a comment block could crash doxygen if the preprocessor was enabled.</li> <li> Fixed problem handling conditional commands and grouping (thanks to Silke Reimer for the patch).</li> -<li> Fixed problem using \dotfile in combination with RTF output +<li> Fixed problem using \dotfile in combination with RTF output (thanks to Vegard Larsen).</li> <li> Fixed several problems related to the new md5 hash feature.</li> -<li> Undocumented functions referenced in a comment block were linked to +<li> Undocumented functions referenced in a comment block were linked to anyway.</li> <li> Fixed a number of typos in the config file documentation (thanks to Boaz Kelmer)</li> @@ -6680,7 +6850,7 @@ make sure you add the following: <li> Fixed bug in code fragment parser that could cause memory corruption in certain cases.</li> <li> Fixed problem matching definition and declaration of functions, which - could cause bogus warnings for functions with the same name but in + could cause bogus warnings for functions with the same name but in different namespaces.</li> <li> Using "/// @file" to document a file quickly was not possible, while "/** @file */" did work. Now both work.</li> @@ -6688,25 +6858,25 @@ make sure you add the following: <h1>Doxygen Release 1.3.4</h1> <h3>Changes</h3> <ul> -<li> Rewrote the search engine. The doxysearch CGI binary has been - replaced by a PHP script which is generated by doxygen. Also the - index file is now generated by doxygen and requires way less memory. - This should make it much easier to use the search facility. +<li> Rewrote the search engine. The doxysearch CGI binary has been + replaced by a PHP script which is generated by doxygen. Also the + index file is now generated by doxygen and requires way less memory. + This should make it much easier to use the search facility. All that is required is a web server with PHP 4.1 or higher. Please report any problems you find.</li> <li> Changed the way class names are resolved. This can result in a significant speedup for projects that use namespaces and typedefs - (including Java projects). Thanks to Edmund Green for the performance + (including Java projects). Thanks to Edmund Green for the performance analysis and ideas.</li> </ul> <h3>New features</h3> <ul> <li> Added support for the &oslash;, and &Oslash; character entities.</li> -<li> Added language updates for Korean, Swedish, German, Russian, +<li> Added language updates for Korean, Swedish, German, Russian, Croatian, Brazilian, Spanish, Japanese, French and Italian.</li> <li> Added new \relatesalso command, which can be used to put a file member also in the documentation of a class (thanks to Ian Scott for the patch).</li> -<li> Added support for pseudo IDL files with the .pidl extension +<li> Added support for pseudo IDL files with the .pidl extension (as used in TAO). Thanks to Éric Malenfant for the patch.</li> <li> Added new commands \dot ... \enddot to include a dot graph in a comment block (thanks to a patch by Eoin MacDonell). Inside the @@ -6728,21 +6898,21 @@ make sure you add the following: heading of the detailed description.</li> <li> Fixed problem handling extern"C" (without the space). </li> <li> \ref file.c ended up as file::c in the output.</li> -<li> Special characters in generated texts were not always translated into +<li> Special characters in generated texts were not always translated into proper LaTeX commands in the LaTeX output.</li> <li> Fixed problem parsing "const ::Class *func()" and "static ::Class *func()". The keywords were seen as namespaces. due to the use of more than one const keyword.</li> <li> Fixed two bugs in compound.xsd schema, thanks to Ademar Aguiar.</li> <li> Fixed some more problems linking typedefs in combination with namespaces.</li> -<li> id 120637: Fixed parse problem handing character literals such +<li> id 120637: Fixed parse problem handing character literals such as '"' inside the initializer list of a constructor.</li> <li> Fixed file handle leak when INLINE_SOURCES was set to YES.</li> <li> Fixed problem handling Java packages (Internal inconsistency warnings).</li> <li> Fixed problem preprocessing @verbatim blocks containing C comments.</li> <li> Fixed problem handling preprocessor statement just before a function body when ENABLE_PREPROCESSING was set to NO.</li> -<li> id 122457: INLINE_SOURCES feature was broken (only showed the +<li> id 122457: INLINE_SOURCES feature was broken (only showed the first line)</li> </ul> <h1>Doxygen Release 1.3.3</h1> @@ -6753,21 +6923,21 @@ make sure you add the following: <li> Added new debug flag "-d Time" which will report the elapsed time for each message printed, and will also show the total running time along with the time spend on external tools such as dot. - Note: If you have a project that takes doxygen a long time to process, + Note: If you have a project that takes doxygen a long time to process, please send me the output so I get a global idea where to optimize.</li> <li> New option SUBGROUPING which can be set to NO to have \nosubgrouping for all classes (thanks to Torben Koch for the patch).</li> -<li> Added XML schemas for validating the XML output, and to help +<li> Added XML schemas for validating the XML output, and to help writing XSLT files. The generated index.xml now has a complete schema, the compounds - not yet. Thanks go to Alexej Humbach for doing a lot of the work. - Note that a couple of "id" attributes in the XML output have been + not yet. Thanks go to Alexej Humbach for doing a lot of the work. + Note that a couple of "id" attributes in the XML output have been changed to "refid", and section tags are now nested.</li> <li> Included language updates for Traditional Chinese and Japanese.</li> </ul> <h3>Bug fixes</h3> <ul> -<li> Doxygen crashed when parsing a comment block with only a \mainpage +<li> Doxygen crashed when parsing a comment block with only a \mainpage command.</li> <li> Fixed problem matching namespace members.</li> <li> Fixed scanner push back error for ALIASES with long definitions.</li> @@ -6779,9 +6949,9 @@ make sure you add the following: warnings.</li> <li> Call graphs were only generated if REFERENCES_RELATION was set to YES.</li> <li> Link could be wrong if a member's name was found in multiple namespaces. </li> -<li> A function returning "struct s *" caused a bogus recursion relation +<li> A function returning "struct s *" caused a bogus recursion relation in the call graph.</li> -<li> Improved handling backslashes for the perlmodgen (thanks to Miguel +<li> Improved handling backslashes for the perlmodgen (thanks to Miguel Lobo).</li> <li> Page anchors did not appear in the tag files.</li> <li> \ref's to grouped pages were not generated correctly.</li> @@ -6790,19 +6960,19 @@ make sure you add the following: commands.</li> <li> Doxygen now issues a warning if invalid commands are used inside a single-line C++ comment (such a @see and @image).</li> -<li> Fixed parse problem for the semicolon in the following: +<li> Fixed parse problem for the semicolon in the following: Class A : a(";") {};</li> -<li> Doxygen now resolves links to classes imported in a namespace +<li> Doxygen now resolves links to classes imported in a namespace via using declarations or directives.</li> <li> Doxygen now issues a warning when @code, @verbatim, @htmlonly, or @latexonly are not properly terminated.</li> <li> Fixed "Internal inconsistency" messages when parsing Java packages.</li> <li> A member did not appear in its group if it was first declared without documentation and then defined with documentation (with \ingroup).</li> -<li> The <caption> tag was put at the end of a <table> - in the HTML output, while it should be the first tag +<li> The <caption> tag was put at the end of a <table> + in the HTML output, while it should be the first tag after <table>. This is now corrected.</li> -<li> In the LaTeX output, the page references were missing for the links +<li> In the LaTeX output, the page references were missing for the links in the documentation when PDF_HYPERLINK was set to NO.</li> </ul> <h1>Doxygen Release 1.3.2</h1> @@ -6818,8 +6988,8 @@ make sure you add the following: of a function to get a callgraph. In the config file a new option CALL_GRAPH is added which can be set to YES to enable callgraphs for all functions (note that this will slow doxygen down!).</li> -<li> Added new boolean config option UML_LOOK which can be enabled to give - class and collaboration diagrams a more UML conformant look +<li> Added new boolean config option UML_LOOK which can be enabled to give + class and collaboration diagrams a more UML conformant look (thanks to Dominick Paniscotti).</li> <li> Added new commands \xmlonly and \endxmlonly which can be paired to form blocks of text that only appear in the XML output.</li> @@ -6829,11 +6999,11 @@ make sure you add the following: </ul> <h3>Bug fixes</h3> <ul> -<li> Doxygen could crash if a namespace and a class with the same +<li> Doxygen could crash if a namespace and a class with the same name were found in the global scope.</li> -<li> Fixed problem handling multiple \xrefitem's in one comment block +<li> Fixed problem handling multiple \xrefitem's in one comment block (could crash doxygen).</li> -<li> Added check for recursive group relations to prevent lock-up/crash while +<li> Added check for recursive group relations to prevent lock-up/crash while generating the group index.</li> <li> Doxygen could crash if a group contained only undocumented members.</li> <li> Putting a #include inside a function body would cause the @@ -6854,13 +7024,13 @@ make sure you add the following: <li> Formula's inside comments directly in front or behind function arguments did not work.</li> <li> Fixed code parser problem when //<! was nested in a normal C comment.</li> -<li> Included a number of fixes for typos found and corrected by Justin +<li> Included a number of fixes for typos found and corrected by Justin Zaglio.</li> -<li> For #define values that were constant strings, doxygen tried to link +<li> For #define values that were constant strings, doxygen tried to link the text inside the string when shown in the documentation.</li> -<li> The source-browse parser did not link to class variables used in +<li> The source-browse parser did not link to class variables used in inline function if the variables were defined before the functions. </li> -<li> The first paragraph after a <h1> or similar heading was not put in +<li> The first paragraph after a <h1> or similar heading was not put in a paragraph context in the generated output.</li> </ul> @@ -6893,7 +7063,7 @@ make sure you add the following: <ul> <li> Added new command \xrefitem which enables user-defined commands that act like \todo and \bug, i.e. produces a related page containing - all items, which is cross-referenced with the documentation blocks + all items, which is cross-referenced with the documentation blocks where the items are placed.</li> <li> Added support for package scope in Java.</li> <li> Added alt attributes to user included images in the HTML output @@ -6905,17 +7075,17 @@ make sure you add the following: </ul> <h3>Bug fixes</h3> <ul> -<li> Occurrences of <span> and <div> tags in the documentation +<li> Occurrences of <span> and <div> tags in the documentation were not properly handled.</li> -<li> Fixed problem parsing the following pattern +<li> Fixed problem parsing the following pattern "namespace { .... } typedef ....", which could crash doxygen if IGNORE_PREFIX was used.</li> <li> The project name is now put in front of each title of a HTML page for easier bookmarking.</li> -<li> In C# enums, classes and structs without (optional) ; were not +<li> In C# enums, classes and structs without (optional) ; were not properly parsed.</li> -<li> Though still not perfect, I Improved the way namespace aliasing is - handled. It should now work inside other namespaces and for +<li> Though still not perfect, I Improved the way namespace aliasing is + handled. It should now work inside other namespaces and for computing class and usage relations.</li> <li> Fixed problem documenting typedefs of function pointers using \typedef.</li> @@ -6923,10 +7093,10 @@ make sure you add the following: <li> Fixed problem resolving class relations for nested classes within namespaces.</li> <li> Static members can now be documented in a separate file using \fn - as long as they have unique names. If the names are not unique the + as long as they have unique names. If the names are not unique the documentation must be located in the same file (as was required before).</li> -<li> In arguments and return types of the form NA::A were not linked if NA - was a namespace alias to a documentation namespace and A a documented +<li> In arguments and return types of the form NA::A were not linked if NA + was a namespace alias to a documentation namespace and A a documented class name.</li> <li> Matching a declaration f(NA::C c) with f(C c) did not work if NA was a namespace alias.</li> @@ -6935,7 +7105,7 @@ make sure you add the following: tag file.</li> <li> Fixed preprocessor bug: "a##b" was not correctly expanded if argument "a" or "b" was empty.</li> -<li> Putting \todo and friends inside the documentation of enum values +<li> Putting \todo and friends inside the documentation of enum values did not result in an entry on the todo list page.</li> <li> Fixed some problems compiling with versions of flex >2.5.4, but also added a #error if these are used, since they produce incompatible @@ -6944,7 +7114,7 @@ make sure you add the following: (thanks to a patch by Michiel Ouwehand).</li> <li> The table row backgroup color of the "all member" list was hard-coded in the HTML output. This is now controlled by the stylesheet.</li> -<li> Fixed problem handling omission of the optional arguments of +<li> Fixed problem handling omission of the optional arguments of the \image command.</li> <li> Enabling HIDE_IN_BODY_DOCS did not work properly if C++-style special comments were used inside the body of a function.</li> @@ -6953,17 +7123,17 @@ make sure you add the following: <li> Setting ENUM_VALUES_PER_LINE to 0 caused a division by 0 error.</li> <li> Autolinking did not work for members that were grouped and imported via tag files.</li> -<li> The divide symbol "/" did not appear in the output for array/define +<li> The divide symbol "/" did not appear in the output for array/define initializers</li> -<li> Fixed paring problem parsing "operator <b>new</b>" +<li> Fixed paring problem parsing "operator <b>new</b>" in the documentation.</li> -<li> Fixed problem with resolving template relations (as reported by +<li> Fixed problem with resolving template relations (as reported by Kris Thielemans).</li> -<li> Members in the todo list were not shown correctly (with dot separators) +<li> Members in the todo list were not shown correctly (with dot separators) if OPTIMIZE_OUTPUT_JAVA was set to YES.</li> <li> Fixed problem handing "class A { public: A::f(); };" which is accepted as valid C++ by a number of compilers.</li> -<li> Putting a /* inside a C-comment without matching */ caused the +<li> Putting a /* inside a C-comment without matching */ caused the preprocessor to ignore the rest of the file.</li> <li> Improved the way typedefs are resolved.</li> <li> Fixed parse problem for the following PHP code: $color='#FFFFFF'</li> @@ -6976,11 +7146,11 @@ make sure you add the following: <h1>Doxygen Release 1.3</h1> <h3>Changes</h3> <ul> -<li> Increased internal buffer size from 16K to 256K for a number of - scanners, so the "input buffer overflow, can't enlarge buffer because +<li> Increased internal buffer size from 16K to 256K for a number of + scanners, so the "input buffer overflow, can't enlarge buffer because scanner uses REJECT" error should occur less easily.</li> <li> Style commands like \e, \a or \c will now be terminated when - one of the characters in the following string is + one of the characters in the following string is found: ".,()[]:;?", example: "a point (consisting of @a x and @a y)"</li> <li> Setting OPTIMIZE_OUTPUT_JAVA to YES, will automatically set INLINE_INFO to NO.</li> @@ -6993,25 +7163,25 @@ make sure you add the following: used to select windows specific character encodings for some languages. (thanks to Piotr Kaminski).</li> <li> Added new configuration option LATEX_HIDE_INDICES which can be - used to suppress the various indices that are normally generated in + used to suppress the various indices that are normally generated in the LaTeX output (thanks to Ken Yarnall for the patch).</li> <li> Added new option MAX_DOT_GRAPH_DEPTH to set the maximum distance - from a root node after which the class or include graph will be + from a root node after which the class or include graph will be truncated. Setting this to a low value should considerably reduce the time doxygen needs on large projects.</li> -<li> Included updates for French, Korean, Polish, Croatian, and +<li> Included updates for French, Korean, Polish, Croatian, and Danish translations.</li> <li> Access to title of user defined user defined sections is now possible from the doxmlparser.</li> -<li> <div> and <span> commands can now by used in the - documentation. Their effect is limited to the HTML output though +<li> <div> and <span> commands can now by used in the + documentation. Their effect is limited to the HTML output though (thanks to Frank Schimmel for the patch)</li> <li> Added inline, virtual, explicit and mutable attributes to XML output (thanks to patch by Michiel Ouwehand).</li> </ul> <h3>Bug fixes</h3> <ul> -<li> Fixed out-of-memory bug for files containing using directives and +<li> Fixed out-of-memory bug for files containing using directives and including themselves (indirectly).</li> <li> Doxygen could crash if two \todo-like commands appeared on the same line.</li> @@ -7024,28 +7194,28 @@ make sure you add the following: <li> Line counting was incorrect when parsing multi-line formulas.</li> <li> \section's in a \mainpage are now correctly numbered in the LaTeX output (nesting level was one too deep).</li> -<li> \ref to lower case names did not work +<li> \ref to lower case names did not work (thanks to Herman ten Brug for the patch)</li> <li> escaped quotes (") were not preserved in the config file when it was updated (thanks to Herman ten Brug for the patch).</li> -<li> PHP related fixes contributed by Vaclav Dvorak: +<li> PHP related fixes contributed by Vaclav Dvorak: <ul> <li> #-style comment handling, </li> <li> adds (problematic) support for define() constants, </li> - <li> adds ".phtml" as a supported file extension for PHP code + <li> adds ".phtml" as a supported file extension for PHP code (not very common, but still...), </li> - <li> fixes handling of code like "include 'file.inc';" (was parsed + <li> fixes handling of code like "include 'file.inc';" (was parsed as a variable definition), </li> <li> removes the variable insidePHPCode (was not needed), </li> <li> fixes spaces in function argument lists (the '$' was the problem).</li> </ul></li> <li> Functions documented with \fn did not get transferred to declaration or definition (depending on where the comment block was put).</li> -<li> If a function definition was documented and grouped the declaration +<li> If a function definition was documented and grouped the declaration was not even if the same documentation block was used for it. </li> -<li> Fixed bug in code parser that could crash doxygen under +<li> Fixed bug in code parser that could crash doxygen under certain conditions.</li> -<li> Fixed some spacing problems in the LaTeX output +<li> Fixed some spacing problems in the LaTeX output (thanks to patches by Roberto Bagnara).</li> <li> Mail address containing the '+' character were not properly parsed (thanks to Jon Parise for the patch).</li> @@ -7054,7 +7224,7 @@ make sure you add the following: \c (or similar command).</li> <li> Preprocessor got confused when parsing a special comment as part of a #define and containing a ' or ".</li> -<li> subgroups defined with @defgroup could be reordered if +<li> subgroups defined with @defgroup could be reordered if @addtogroup was used.</li> <li> Projects name was not shown as the root of the treeview anymore.</li> <li> Links to pages imported via tag files were broken in the treeview @@ -7082,7 +7252,7 @@ make sure you add the following: <li> Verbatim fragments were not properly rendered in the RTF output.</li> <li> Fixed some cases where collaboration relations were not visible due to typedefs.</li> -<li> Fixed some compiler warnings that occurred with more recent versions +<li> Fixed some compiler warnings that occurred with more recent versions of gcc.</li> <li> Auto-links to files were shown with as file::c instead of file.c. </li> <li> @ref namespace::class was not parsed correctly.</li> @@ -7092,21 +7262,21 @@ make sure you add the following: <li> Hyperlinks in the LaTeX were broken in some cases.</li> <li> Fixed case where a global variable was not linked from within a function body.</li> -<li> Include dependencies graph was shown at the place where the +<li> Include dependencies graph was shown at the place where the "included by" graph should have appeared.</li> <li> A // comment following by a //! comment was not handled properly by the source browser.</li> <li> If the definition of nested class was found before the definition of the outer class, its name was displayed without scope.</li> <li> If a parameter of a prototype was documented (with a separate - documentation block) and the name of the parameter in the definition + documentation block) and the name of the parameter in the definition was different, the wrong name could be shown in the documentation.</li> <li> Fixed bug handling \line, \skipline, and \until</li> </ul> <h1>Doxygen Release 1.3-rc3</h1> <h3>Changes</h3> <ul> -<li> Rewrote the implementation of the tree view feature +<li> Rewrote the implementation of the tree view feature (see GENERATE_TREEVIEW). The new implementation should be much faster, but does require a browser that supports JavaScript, DHTML, and CSS. Please report any problems you find.</li> @@ -7116,16 +7286,16 @@ make sure you add the following: by Tom Emerson).</li> <li> STRIP_FROM_PATH now ignores the exact casing of characters, which makes things simpler on Windows.</li> -<li> Style modifiers such as <b>, <em> and <pre> are now +<li> Style modifiers such as <b>, <em> and <pre> are now capable of spanning multiple paragraphs.</li> <li> Made some improvements to the documentation, including a diagram - showing the information flow between the doxygen and various other + showing the information flow between the doxygen and various other tools (see the getting started section).</li> </ul> <h3>New features</h3> <ul> -<li> Added support for comment blocks generated by - Rational Rose's ANSI C++ code generator (thanks to a patch by +<li> Added support for comment blocks generated by + Rational Rose's ANSI C++ code generator (thanks to a patch by Martin Beaudoin).</li> <li> Included language update for the Serbian and Japanese.</li> <li> Included patch by Ryunosuke Satoh to reduce size of the executable when @@ -7138,7 +7308,7 @@ make sure you add the following: <ul> <li> @addindex now works on the whole line instead of a single word (as was already suggested in the docs).</li> -<li> source code line in the XML output didn't escape special characters +<li> source code line in the XML output didn't escape special characters like & anymore.</li> <li> Fixed small bug in German translation (thanks to Jens Seidel).</li> <li> e-mail addresses with multiple dots got truncated when linked.</li> @@ -7150,7 +7320,7 @@ make sure you add the following: a semicolon (thanks to Jaime Uriel Torres for the patch).</li> <li> Using <dt> with also adding a <dd> caused a parse error while it is legal HTML.</li> -<li> The identifier "package" in C/C++ code was wrongly interpreted as +<li> The identifier "package" in C/C++ code was wrongly interpreted as a Java keyword.</li> <li> \todo item at the end of a comment block caused "unexpected character" error while generating the XML output.</li> @@ -7171,12 +7341,12 @@ make sure you add the following: <li> Links to files or file members could be wrong if SHORT_NAMES was set to YES and the file was imported via a tag file.</li> <li> Attribute lists inside an enum in an IDL file were not properly parsed.</li> -<li> Fixed problem in code browser that prevented linking to global +<li> Fixed problem in code browser that prevented linking to global variables defined in other files.</li> <li> When putting a "using namespace X" in a header file doxygen did not recognize this in files that included the header file.</li> <li> Fixed bug in parsing sections without title.</li> -<li> doxytag did not include anchor in the search index. Thanks to +<li> doxytag did not include anchor in the search index. Thanks to Joerg Schlichenmaier for the fix.</li> <li> Using an auto-list as an argument of @todo and friends did not work.</li> <li> A class with all members in a section grouped could result in broken @@ -7186,13 +7356,13 @@ make sure you add the following: <h3>New features</h3> <ul> <li> Added support for importing members via using declarations.</li> -<li> Anchors and sections (and references to them) are now supported in +<li> Anchors and sections (and references to them) are now supported in all comment blocks, not just \page blocks.</li> <li> Dot files imported via @dotfile now produce images maps in the HTML output. Use the URL node attribute in the dot file to make a link (thanks to Marco Dalla Gasperina for the patch).</li> <li> New config option WARN_IF_DOC_ERROR which allows documentation problems - to be shown, while other warnings (such as warnings about + to be shown, while other warnings (such as warnings about undocumented members) can be hidden (thanks to Miguel for the patch).</li> <li> Included language update for German and Italian.</li> <li> Added support for &tm; (trademark) and &reg; (registered). </li> @@ -7200,7 +7370,7 @@ make sure you add the following: </ul> <h3>Bug fixes</h3> <ul> -<li> A <pre> .. </pre> section with included blank lines +<li> A <pre> .. </pre> section with included blank lines causes warning about missing </pre> marker.</li> <li> "typedef enum { a };" confused doxygen's parser, while most compilers seem to accept it without warnings.</li> @@ -7232,13 +7402,13 @@ make sure you add the following: <h1>Doxygen Release 1.3-rc1</h1> <h3>Changes</h3> <ul> -<li> New validating parser for documentation blocks that replaces the +<li> New validating parser for documentation blocks that replaces the old parser (which was actually only a lexical scanner).</li> <li> The new documentation parser will now pass attributes of html tags to the html output. Example: <pre> /*! \mainpage A Dutch Table - * <table bgcolor="black" border="0" cellspacing="2" + * <table bgcolor="black" border="0" cellspacing="2" * cellpadding="2" align="center"> * <tr><td bgcolor="red">red * <tr><td bgcolor="white">white @@ -7247,7 +7417,7 @@ make sure you add the following: */ </pre></li> <li> Doxywizard will now run doxygen from the directory where the - config file is found, so paths can be made relative + config file is found, so paths can be made relative in the config file. This will now also work if the config file's path or name contains spaces.</li> <li> Doxygen style comment blocks found in the body of functions are @@ -7258,10 +7428,10 @@ make sure you add the following: <li> Added rudimentary support for C#. Parsing should work, but not all attributes are handled correctly.</li> <li> Included perl module generator by Miguel Lobo. Setting - GENERATE_PERLMOD to YES in the config file will produce + GENERATE_PERLMOD to YES in the config file will produce a perl module in the output dir.</li> <li> Included language updates for French, Czech, and Russian.</li> -<li> Included a number of enhancements to the xml parser (thanks to +<li> Included a number of enhancements to the xml parser (thanks to a patch by Tree).</li> <li> Locally documented parameters now appear in the XML output (thanks to Cormac Twomey for the patch). </li> @@ -7273,7 +7443,7 @@ make sure you add the following: properly.</li> <li> Warnings for undocumented members were not generated anymore in certain cases.</li> -<li> A member of a group linked with \ref showed the group's title +<li> A member of a group linked with \ref showed the group's title as link text instead of the member's name.</li> <li> Using aliased commands whose definition contained \n's caused the code browser to put definition links at the wrong line numbers.</li> @@ -7281,18 +7451,18 @@ make sure you add the following: about duplicated labels.</li> <li> Included a patch by Ryunosuke Satoh that fixes some issues when compiling in a cygwin environment.</li> -<li> The presence of using declarations could result bogus entries in the +<li> The presence of using declarations could result bogus entries in the class hierarchy.</li> -<li> Links in the hyperlinked sources could point to the wrong global +<li> Links in the hyperlinked sources could point to the wrong global function depending on the order in which files were parsed.</li> -<li> Using \retval in combination with parameters that are documented +<li> Using \retval in combination with parameters that are documented on the spot, caused bogus warnings about undocumented parameters.</li> -<li> id attributes of references/referencedby relations are wrong in +<li> id attributes of references/referencedby relations are wrong in the XML output.</li> -<li> Links could wrongly point to a class in an outer scope instead of a +<li> Links could wrongly point to a class in an outer scope instead of a typedef with the same name in the inner scope.</li> -<li> A reference in the code to a member of a derived class that is defined - in a base class is now resolved properly even if both classes are +<li> A reference in the code to a member of a derived class that is defined + in a base class is now resolved properly even if both classes are imported via tag files.</li> <li> Language codes were wrong in the html help output for some languages (thanks to Erwin Hoffmann for the patch).</li> @@ -7302,9 +7472,9 @@ make sure you add the following: <li> Included RTF output fixes by Gorden Machel.</li> <li> Global variables of complex types were not properly cross-referenced.</li> <li> Fixed argument matching bug for nested template classes; - matching <code>"f(A::B<T>::C c)"</code> with + matching <code>"f(A::B<T>::C c)"</code> with <code>"f(C c)"</code> within context <code>A::B<T></code></li> -<li> Fixed preprocessor bug handling nested comment blocks +<li> Fixed preprocessor bug handling nested comment blocks (the */ of the inner block was eaten).</li> </ul> <p> @@ -7316,10 +7486,10 @@ make sure you add the following: <h3>Changes</h3> <ul> <li> Running doxygen with the "-d Validate" option will activate a - new documentation parser. The parser will produce output for - Html, Latex, XML and RTF output (man page output still needs to be done). + new documentation parser. The parser will produce output for + Html, Latex, XML and RTF output (man page output still needs to be done). For XML output this new parser will <em>always</em> be used. - Please try it and let me know if you see unexpected errors or + Please try it and let me know if you see unexpected errors or invalid output. This parser will replace the old one in the next release. <p> @@ -7327,13 +7497,13 @@ make sure you add the following: syntax of the documentation blocks and will produce valid output by design. </p> <p> - For debugging purposes, adding "-d PrintTree" along - with "-d Validate" will let doxygen dump the abstract syntax tree of - each documentation block to the output in a pretty printed way + For debugging purposes, adding "-d PrintTree" along + with "-d Validate" will let doxygen dump the abstract syntax tree of + each documentation block to the output in a pretty printed way (this reflects the structure built-up by the parser).</p> </li> <li> A number of new XML tags are introduced along with the new parser, these include: umlaut, acute, grave, circ, tilde, szlig, cedil, ring - nonbreakablespace, toclist, tocitem, xrefsect, xrefdescription, + nonbreakablespace, toclist, tocitem, xrefsect, xrefdescription, and xreftitle.</li> <li> Changed the way code fragments are represented in XML to simplify validation.</li> @@ -7343,7 +7513,7 @@ make sure you add the following: <li> \page now results in a section in latex (of the related pages chapter)</li> <li> - \section is now a subsection within that page section (used to be a + \section is now a subsection within that page section (used to be a section, so at the same level as \page)</li> <li> \subsection is now a subsubsection within a subsection (used to be a @@ -7353,7 +7523,7 @@ make sure you add the following: <ul> <li> Undocumented private friend classes no longer cause warnings</li> <li> Undocumented private classes no longer cause warnings</li> - <li> Undocumented members are now hidden if they are + <li> Undocumented members are now hidden if they are default constructors, destructors or reimplemented.</li> </ul></li> <li> Pages introduced via \page are now context aware. This means that @@ -7371,33 +7541,33 @@ make sure you add the following: <li> Enum value documentation was added to the XML output.</li> <li> Files ending with ".inc" are now recognized as PHP files (thanks to Marcus Ahlfors).</li> -<li> Included updated documentation for language translators +<li> Included updated documentation for language translators (thanks to Petr Prikryl).</li> <li> Included language updates for Czech, Slovak, Brazilian, Croatian, - Portuguese, Russian, Polish, Japanese and Serbian. + Portuguese, Russian, Polish, Japanese and Serbian. Include language support for Catalan (thanks to Albert Mora)</li> -<li> Included .dsp update by Simon Goodwin (already needs to be updated +<li> Included .dsp update by Simon Goodwin (already needs to be updated again :-( )</li> <li> Added new configuration options XML_DTD and XML_SCHEMA to set the DTD or Schema used in the XML output.</li> <li> Include new commands \subsubsection and \paragraph which add two - section level below \section and \subsection (thanks to + section level below \section and \subsection (thanks to Dirk Reiners for the patch) </li> </ul> <h3>Bug fixes</h3> <ul> <li> Fixed lock-up bug in RTF output when using tables.</li> -<li> The internal comment conversion routine was confused by lines of the +<li> The internal comment conversion routine was confused by lines of the form //*************</li> <li> Fixed recursive lockup for template arguments of the form "typename A = ::A"</li> <li> Description part of @name did not (always) appear in the resulting documentation.</li> <li> Alphabetic index showed package scope using "::" even when - OPTIMIZE_OUTPUT_JAVA was set to YES. The same happened for class and + OPTIMIZE_OUTPUT_JAVA was set to YES. The same happened for class and namespace HTML page titles.</li> <li> New versions of dot (graphviz >=1.8.8) broke clickable images - for versions of doxygen <=1.2.17. Now fixed for newer doxygen + for versions of doxygen <=1.2.17. Now fixed for newer doxygen releases in a backwards compatible way thanks to a patch by John Ellson.</li> <li> Fixed compile problem for 64 bit machines (pointer to int cast).</li> <li> Included patch to build Doxygen 1.2.17 on AIX 4.3 by Russ Allbery</li> @@ -7411,7 +7581,7 @@ make sure you add the following: documentation not to appear in the output at all.</li> <li> Fixed todo list linking problems for hyperlinked pdf output and grouped pages.</li> -<li> Putting a function declaration and its definition in the same group +<li> Putting a function declaration and its definition in the same group could lead to wrong links using @ref.</li> <li> Undocumented but grouped members did not appear in the output.</li> <li> The declaration and definition of overloaded global functions @@ -7426,17 +7596,17 @@ make sure you add the following: <h1>Doxygen Release 1.2.17</h1> <h3>Changes</h3> <ul> -<li> XML: The index of the XML output now has @refid instead of @id's, +<li> XML: The index of the XML output now has @refid instead of @id's, and includes a "kind" attribute for the compounds and members for easier filtering.</li> -<li> Improved dot image generation speed for large projects by changing +<li> Improved dot image generation speed for large projects by changing the way the best-fitting graph is computed (thanks to Philip Bergen for the suggestion).</li> <li> @name now automatically starts a member group section (previously - a @{ command was needed). The member group continues until a new @name - command is found or until the end of a compound is reached. @{ ... @} - commands can still be used for backward compatibility or to end a member - group before the end of a compound. @defgroup and friends still require + a @{ command was needed). The member group continues until a new @name + command is found or until the end of a compound is reached. @{ ... @} + commands can still be used for backward compatibility or to end a member + group before the end of a compound. @defgroup and friends still require explicit @{ ... @} blocks.</li> <li> Changed the way \todo, \bug, and \test are handled internally. This should have no visible effect on the outside, but makes it much @@ -7444,8 +7614,8 @@ make sure you add the following: </ul> <h3>New features</h3> <ul> -<li> Added initial support for parsing PHP code (thanks to a patch by - Jan Borsodi). For a PHP file the following additional commands are +<li> Added initial support for parsing PHP code (thanks to a patch by + Jan Borsodi). For a PHP file the following additional commands are available: <dl> <dt>\private </dt><dd> makes the current item private</dd> @@ -7460,14 +7630,14 @@ make sure you add the following: <li> New command @copydoc that can be used to copy a documentation block of some item and paste it in another documentation block.</li> <li> i18n: Added support for the Serbian language (thanks to Dejan Milosavljevic). - Included a new language option Japanese-en for combined Japanese + Included a new language option Japanese-en for combined Japanese and English.</li> -<li> Included patch for dealing with variable argument macros in @param +<li> Included patch for dealing with variable argument macros in @param (thanks to Alfred Heggestad).</li> <li> Added new option MULTILINE_CPP_IS_BRIEF to make doxygen treat a multi-line brief comment block as a brief description. Set this to YES to obtain the behavior of version 1.2.15 and earlier. Default as - of version 1.2.16 is to treat multi-line C++ comment block as a + of version 1.2.16 is to treat multi-line C++ comment block as a detailed description.</li> <li> New option CHM_FILE to set the .chm file (and path) to use for Html Help output.</li> @@ -7486,23 +7656,23 @@ make sure you add the following: was set to YES.</li> <li> Documentation blocks for function arguments in a documented header file did not show up if the function definition was parsed first.</li> -<li> Inheritance relations in Java where not always correctly resolved if +<li> Inheritance relations in Java where not always correctly resolved if the base class was explicitly scoped.</li> <li> Fixed some non-standard conformance issues in the HTML output (thanks to John Levon for the patch).</li> <li> Usage relations for variables whose type was a qualified typedef were not properly resolved.</li> -<li> Fixed potential crash bug (null-pointer dereference) in source browser +<li> Fixed potential crash bug (null-pointer dereference) in source browser parser.</li> -<li> Comment blocks ending with an empty /// comment line were not +<li> Comment blocks ending with an empty /// comment line were not properly handled by the comment conversion code.</li> -<li> @relates is no longer needed for a friend function documented in +<li> @relates is no longer needed for a friend function documented in the source file (thanks to Johan Eriksson for the fix).</li> <li> Doxygen could link include files to non-existing source files, if they pointed to external files but were also found in the include path.</li> <li> "make install_docs" was broken.</li> <li> Fixed parse bug for conversion operators of the form "operator ::X*()"</li> -<li> XML output fixes: +<li> XML output fixes: <ul> <li> derivedcompoundref was not terminated properly. </li> <li> innerpage and innergroup were closed twice.</li> @@ -7510,20 +7680,20 @@ make sure you add the following: in the XML output.</li> <li> para tags in simple section in the XML output were not properly matched</li> </ul></li> -<li> PDF output fixes: +<li> PDF output fixes: <ul> <li> Fixed pdflatex reruns in the Makefile when USE_PDFLATEX was YES. It should now run the proper amount of times (thanks to Simon Goodwin for the fix).</li> <li> Links to items in the bug list were broken for the PDF output.</li> - <li> Fixed bug in PDF output that resulted in links to non-existing + <li> Fixed bug in PDF output that resulted in links to non-existing source pages.</li> - <li> Fixed bug in URL parsing that caused invalid PDF output for the + <li> Fixed bug in URL parsing that caused invalid PDF output for the doxygen manual.</li> <li> Doxygen logo did not appear in the PDF manual.</li> </ul></li> -<li> RTF output fixes/improvements by Janet Swisher, - Gordon Machel & Martin Vuille: +<li> RTF output fixes/improvements by Janet Swisher, + Gordon Machel & Martin Vuille: <ul> <li> Included fix for loading RTF style-sheets</li> <li> reference list and title were merged</li> @@ -7543,14 +7713,14 @@ make sure you add the following: <li> Fixed bug parsing URLs with curly braces in documentation blocks.</li> <li> Html help output now uses the correct language code if non English language is selected.</li> -<li> Fixed bug in generate makefile for latex output (thanks to Petr +<li> Fixed bug in generate makefile for latex output (thanks to Petr Prikryl)</li> -<li> Fixed source browser bug: a comment just before a function body +<li> Fixed source browser bug: a comment just before a function body confused the parser.</li> <li> Fixed problem handling function typedefs.</li> <li> \endif appeared in output when used via ALIASES in a brief description.</li> -<li> Included heuristic to distinguish between a variable definition - with initialization via a constructor and a function prototype +<li> Included heuristic to distinguish between a variable definition + with initialization via a constructor and a function prototype (e.g. "Test var(initVal);", v.s. "Test func(SomeType);").</li> <li> Fixed lock-up problem when to @brief were put after each other in a comment block.</li> @@ -7558,18 +7728,18 @@ make sure you add the following: <li> Members in source fragments and examples were not linked to their member group documentation if available.</li> <li> For initializers of the form ' ', the space was removed in the output. </li> -<li> \dotfile generated files did not get generated correctly because dot +<li> \dotfile generated files did not get generated correctly because dot could not find the specified font.</li> <li> Third argument of \class did not always work.</li> <li> The pattern argument for the @skip, @skipline, @until and @line commands - now extents until the end of the line (as suggested by the documentation) + now extents until the end of the line (as suggested by the documentation) instead of just the first word. </li> </ul> <h1>Doxygen Release 1.2.16</h1> <h3>Changes</h3> <ul> -<li> Verbatim and preformatted sections +<li> Verbatim and preformatted sections are now represented with a new "preformatted" tag in the XML output.</li> <li> The HIDE_UNDOC_RELATIONS option is no longer depending on HAVE_DOT being set to YES.</li> @@ -7579,11 +7749,11 @@ make sure you add the following: //! Detailed //! Description as a detailed description - (such blocks used to be treated as brief descriptions!). + (such blocks used to be treated as brief descriptions!). A single line C++ comments still represents a brief description, for multiline brief description an explicit @brief can be used. See the updated documentation for more examples.</li> -<li> XML: Added class name to inheritance relations that are written to the +<li> XML: Added class name to inheritance relations that are written to the XML output.</li> <li> Images included with \dotfile are now centered in the latex output (thanks to Nils Strom for the patch).</li> @@ -7595,9 +7765,9 @@ make sure you add the following: <li> Made include dependency graphs available from the XML parser API.</li> <li> Added patch to support multi-byte RTF output (thanks to Sato Ryunosuke)</li> <li> Gary Lee added language support for Chinese-Traditional. </li> -<li> Thanks to a patch by Loïc the RTF output now supports (non-nested) +<li> Thanks to a patch by Loïc the RTF output now supports (non-nested) tables.</li> -<li> Added compilation support for cygwin (win32-g++ target). +<li> Added compilation support for cygwin (win32-g++ target). Thanks to Ryunosuke Sato for the patch.</li> <li> Added new option DETAILS_AT_TOP to put the detailed documentation at the top of a documentation page where normally only the brief @@ -7606,20 +7776,20 @@ make sure you add the following: </ul> <h3>Bug fixes</h3> <ul> -<li> Improved portability of the png code: updated zlib to version 1.1.4, - replaced K&R style code by ansi code, fixed compile problem with +<li> Improved portability of the png code: updated zlib to version 1.1.4, + replaced K&R style code by ansi code, fixed compile problem with pngenc.cpp on some platforms.</li> <li> Fixed recursive lock-up problem that could occur for certain cases in which recursive template inheritance was used.</li> <li> The cross-package inheritance relations were broken for Java code. I fixed this by treating Java import statement as C++ using statements. Please report any problems that remain.</li> -<li> Alias commands put in separate parameter documentation blocks +<li> Alias commands put in separate parameter documentation blocks were not resolved.</li> -<li> The documentation for arguments, documented with a separate - documentation block, was not consistently shown in source and header +<li> The documentation for arguments, documented with a separate + documentation block, was not consistently shown in source and header files, depending on the order of the input files. </li> -<li> The characters '(', ')', '$', ''', and ';' were not recognized +<li> The characters '(', ')', '$', ''', and ';' were not recognized as part of an URL.</li> <li> Grouped enum values could not share the same documentation block even when DISTRIBUTE_GROUP_DOC is YES. </li> @@ -7628,9 +7798,9 @@ make sure you add the following: <li> Removed warning when documenting include guard-like defines. </li> <li> The \package command was broken. Fixed cases where :: appeared in the output when OPTIMIZE_OUTPUT_JAVA was set to YES.</li> -<li> Fixed scoping problem using \class for documenting nested classes inside +<li> Fixed scoping problem using \class for documenting nested classes inside template classes.</li> -<li> Fixed invalid output bug when putting "-" items inside @arg or @li +<li> Fixed invalid output bug when putting "-" items inside @arg or @li lists.</li> <li> Fixed problem referencing functions using {@link ... } with explicit argument lists.</li> @@ -7641,16 +7811,16 @@ make sure you add the following: <li> Fixed bug in conditional section handling for cases like: @if guard text @else more text @endif</li> <li> The html help files did not honor the HTML_FILE_EXTENSION settings.</li> -<li> Removed bogus warning when using @param for function-type +<li> Removed bogus warning when using @param for function-type parameters.</li> -<li> Include statements in the source browser output now link to the +<li> Include statements in the source browser output now link to the right include file in case of ambiguities. </li> <li> The include lines in the file documentation didn't link to files that were imported from tag files. </li> <li> The include dependency graph did not show include files if they were directly or indirectly imported from tag files. Existing tag files need to be regenerated to make use of this.</li> -<li> XML: The refid of members in listofallmembers section in the XML output +<li> XML: The refid of members in listofallmembers section in the XML output was wrong. The ulink tag did not end properly in the XML output. The Value of ambiguityscope in the XML output was not properly escaped. LaTeX page reference texts appeared in the XML output.</li> @@ -7659,10 +7829,10 @@ make sure you add the following: reordered const) as equivalent types.</li> <li> The preprocessor now avoids recursive includes, which helps to parse files that do not have proper #ifndef-#define .. #endif guards.</li> -<li> Matching arguments with types "unsigned long int" and - "unsigned long int blah" removed argument name. +<li> Matching arguments with types "unsigned long int" and + "unsigned long int blah" removed argument name. Same for "int" and "const int blah".</li> -<li> Fixed LaTeX output bug that occurs when using \dotfile in combination +<li> Fixed LaTeX output bug that occurs when using \dotfile in combination with USE_PDFLATEX = YES (thanks to Nils Strom for the patch).</li> <li> Links to static functions in the documentation, now point to the local file in case of ambiguities.</li> @@ -7670,28 +7840,28 @@ make sure you add the following: <li> Fixed bug parsing "class C : public ::C {};" inside a namespace.</li> <li> Fixed bug in tag file reader when parsing includes.</li> <li> The include dependencies were wrong if an include file name was part of - the input but the #include specifically asked for another file + the input but the #include specifically asked for another file not part of the input but with the same name.</li> </ul> <h1>Doxygen Release 1.2.15</h1> <h3>Changes</h3> <ul> -<li> On request of Richard Stallman and others I replaced all - generated GIF images with PNG images. - See <a href="http://www.burnallgifs.org">http://www.burnallgifs.org</a> +<li> On request of Richard Stallman and others I replaced all + generated GIF images with PNG images. + See <a href="http://www.burnallgifs.org">http://www.burnallgifs.org</a> for the motivation.</li> -<li> The Documentation of function definitions and declarations are now - always merged. References/Referenced by relations are now equal +<li> The Documentation of function definitions and declarations are now + always merged. References/Referenced by relations are now equal for function declarations and definitions.</li> <li> When @retval commands are used to document parameters, doxygen will no longer produce a warning message for that parameter. @retval can still be used to document non parameters such as the return values of a function.</li> -<li> <pre>#define A(x) x /**< a define */</pre> +<li> <pre>#define A(x) x /**< a define */</pre> will document a define, while <pre>#define A(x) /** an argument */ x</pre> will document the argument of the define</li> -<li> Links in the documentation to const/volatile members are now +<li> Links in the documentation to const/volatile members are now possible by explicitly specifying "f() const" or "f() volatile" in case a non-const/volatile "f()" also exists.</li> <li> Doxygen now warns about undocumented compounds (thanks to Itai Frenkel @@ -7700,17 +7870,17 @@ make sure you add the following: <h3>New features</h3> <ul> <li> Included language update for Russian and Romanian translations.</li> -<li> EPS images included with "\image latex" are automatically converted +<li> EPS images included with "\image latex" are automatically converted to pdf's when USE_PDFLATEX is set to YES.</li> -<li> Added two new commands: LATEX_CMD_NAME and MAKEINDEX_CMD_NAME to +<li> Added two new commands: LATEX_CMD_NAME and MAKEINDEX_CMD_NAME to set the name of the latex and makeindex tools to be used for latex output (thanks to Konno Akihisa for the patch).</li> <li> Improved support for Java. Packages are now treated like - C++ namespaces and there is a new option OPTIMIZE_OUTPUT_JAVA + C++ namespaces and there is a new option OPTIMIZE_OUTPUT_JAVA that, when enabled, provides more Java-oriented output. Please report any Java-related problems that remain.</li> <li> Extended XML parser API (see addon/doxmlparser/include/doxmlintf.h) - with full access to documentation blocks. + with full access to documentation blocks. Made inheritance/collaboration diagrams accessible via the XML parser API (see addon/doxmlparser/include/doxmlintf.h). Reorganized the internals of the XML parser so the API does @@ -7719,26 +7889,26 @@ make sure you add the following: </ul> <h3>Bug fixes</h3> <ul> -<li> Using "@param x,y,z" resulted bogus warnings about undocumented +<li> Using "@param x,y,z" resulted bogus warnings about undocumented parameters.</li> <li> "doxygen -w latex header.tex doxygen.sty Doxyfile" caused a segmentation fault (thanks to Aric Cyr for the patch).</li> -<li> Fixed argument matching problem that occurred in some rare cases +<li> Fixed argument matching problem that occurred in some rare cases that involved "using" of namespaces.</li> <li> Using /**< Brief.\ more brief. Details. */ with ENABLE_JAVADOC = YES, now removes the slash just like it did with /**...*/ style comments. </li> <li> Using an ordered, html-style list inside a @param command resulted in invalid output if list item contained blank lines.</li> -<li> STRIP_FROM_PATH now also works with Windows style paths +<li> STRIP_FROM_PATH now also works with Windows style paths (e.g. C:\MyPath\)</li> <li> A module can now appear more than once in the module tree (thanks to Itai Frenkel for the patch).</li> <li> In some cases the tree view showed leaf elements as non-leafs. </li> -<li> Fixed a number of cases where illegal characters could end up in +<li> Fixed a number of cases where illegal characters could end up in the XML output.</li> <li> If a function in a base class was (re)implemented by several classes only one of them appeared in the "(re)implemented in" list. </li> -<li> graph_legend.gif was hardcoded in translator_*.h files. +<li> graph_legend.gif was hardcoded in translator_*.h files. Note to translators: this has affected all translator files, so please update your local translator file!</li> <li> In some cases a grouped member within a namespace did not appear @@ -7748,8 +7918,8 @@ make sure you add the following: <li> Using directives inside anonymous namespaces had no effect.</li> <li> Fixed bug in the preprocessor when parsing '"' as the argument to a function macro.</li> -<li> The argument of commands like \c did not produce a link to - external documentation if possible, while links to local +<li> The argument of commands like \c did not produce a link to + external documentation if possible, while links to local documentation were generated.</li> </ul> @@ -7759,10 +7929,10 @@ make sure you add the following: <li> Split up the XML output into an index (index.xml) and one page per compound. This allows for faster processing and less memory consumption, when using DOM style parsers.</li> -<li> Include files are now shown in the class documentation if +<li> Include files are now shown in the class documentation if and only if SHOW_INCLUDE_FILES is YES. </li> -<li> Doxygen-style C comments inside macro definitions are now preserved - in the output. Example: +<li> Doxygen-style C comments inside macro definitions are now preserved + in the output. Example: <pre> #define INIT(x) /*! Initializes x. */ void Init() { x = 0; } </pre></li> @@ -7773,33 +7943,33 @@ make sure you add the following: </ul> <h3>New features</h3> <ul> -<li> Added a very simple metrics utility - (see addon/doxmlparser/examples/metrics) which can compute some +<li> Added a very simple metrics utility + (see addon/doxmlparser/examples/metrics) which can compute some figures based on the XML output generated by doxygen.</li> <li> Added autodetection for Darwin (MacOSX) to the configure script.</li> <li> Added option EXCLUDE_SYMLINKS. - The EXCLUDE_SYMLINKS tag can be used to select whether or not files or - directories that are symbolic links (a Unix filesystem feature) are + The EXCLUDE_SYMLINKS tag can be used to select whether or not files or + directories that are symbolic links (a Unix filesystem feature) are excluded. </li> -<li> Added option EXTERNAL_GROUPS. - If the EXTERNAL_GROUPS tag is set to YES all external groups - will be listed in the modules index. If set to NO, only the +<li> Added option EXTERNAL_GROUPS. + If the EXTERNAL_GROUPS tag is set to YES all external groups + will be listed in the modules index. If set to NO, only the current project's groups will be listed. (thanks to Darren Oldag for the patch).</li> <li> Included update for translator.pl (thanks to Petr Prikryl)</li> <li> updated .spec file (thanks to Emilio Riva).</li> -<li> Included patch by Jochen Hanff to make the index headings configurable +<li> Included patch by Jochen Hanff to make the index headings configurable via style-sheets.</li> -<li> If a comment block contains at least one @param command, doxygen now +<li> If a comment block contains at least one @param command, doxygen now produces warnings if not all parameters of a function are documented or - if the names of the parameters do not match the argumentlist. + if the names of the parameters do not match the argumentlist. (Please report any false alarms).</li> -<li> Added new command \~language_id to create sections that +<li> Added new command \~language_id to create sections that are outputted for the language >language_id> only: - Example: + Example: <pre> - /** \~czech Cesky komentar \~english English comment text \~dutch - Nederlands commentaar \~ Common comment for all languages, + /** \~czech Cesky komentar \~english English comment text \~dutch + Nederlands commentaar \~ Common comment for all languages, this tag switches off the language filter... */ </pre> @@ -7807,25 +7977,25 @@ make sure you add the following: on the setting of OUTPUT_LANGUAGE (Thanks to Milan Rusek for the patch).</li> <li> Added build support for Cygwin (thanks to Ryunosuke Sato). </li> <li> Added new option HTML_FILE_EXTENSION to allow different file extension - for the html file outputted by doxygen (like .php). Thanks to + for the html file outputted by doxygen (like .php). Thanks to Rob Olsthoorn for the patch.</li> <li> Added option DOT_IMAGE_FORMAT that can be used to set the image format of images generated by dot (possible formats: gif, png, jpg).</li> -<li> In the documentation of class, namespace, file and group items a +<li> In the documentation of class, namespace, file and group items a list of groups to which the item belongs is put between brackets ([..]) under the title (HTML only).</li> -<li> Added "list of all members" and template parameter lists for +<li> Added "list of all members" and template parameter lists for classes to the XML output.</li> -<li> Included language updates for Chinese, Czech, French, Italian, +<li> Included language updates for Chinese, Czech, French, Italian, Brazilian, Japanese, Russian and German.</li> </ul> <h3>Bug fixes</h3> <ul> -<li> The start of a comment (/*) embedded in a page or example block +<li> The start of a comment (/*) embedded in a page or example block caused parse problems.</li> <li> operator%= member caused latex error when in pdf hyperlink mode.</li> <li> fixed parse problem for global function typedefs like "typedef int f()"</li> -<li> Qt slots weren't included in the reference/referenced by relations +<li> Qt slots weren't included in the reference/referenced by relations (thanks to Gordon Machel for the patch).</li> <li> Fixed parse problem that occurred when the <SUP> tag was used in a brief description. </li> @@ -7833,21 +8003,21 @@ make sure you add the following: EXTRACT_PRIVATE was NO.</li> <li> Doxygen now exits with code 0 if there is no error (previously it returned 1 in some cases were no error occurred).</li> -<li> Calling "doxygen -g -" now writes the config file to stdout +<li> Calling "doxygen -g -" now writes the config file to stdout (this already worked when using "doxygen -g-").</li> <li> Undocumented classes exposed when setting EXTRACT_ALL to YES, could result in broken links in the class hierarchy.</li> <li> Exception specifications in Java were not parsed properly.</li> <li> If INLINE_INHERITED_MEMB was YES, pure virtual members of base classes - reachable via multiple paths appeared more than once in the + reachable via multiple paths appeared more than once in the documentation.</li> <li> Removed potential recursive loop when computing reimplements relations for template instances.</li> -<li> Fixed argument matching problem when matching "a<int *>" with +<li> Fixed argument matching problem when matching "a<int *>" with a<int * >"</li> -<li> Links in the documentation of grouped namespace members were not +<li> Links in the documentation of grouped namespace members were not pointing to the group but to the namespace.</li> -<li> For template specializations the title of an html page contained +<li> For template specializations the title of an html page contained plain < and > characters.</li> <li> When computing source references undocumented members could introduce non-existing relations for documented members in front of it.</li> @@ -7858,13 +8028,13 @@ make sure you add the following: treated as virtual.</li> <li> Protected members of a base class did not appear as such in the list of all members of derived classes.</li> -<li> Fixed problem with ending itemized lists before paragraph commands +<li> Fixed problem with ending itemized lists before paragraph commands (like @see), which resulted in invalid output.</li> -<li> The version number in config files generated by doxywizard was +<li> The version number in config files generated by doxywizard was always 0.1.</li> <li> Having a macro function and typedef with the same name confused doxygen.</li> <li> An \endverbatim command at the end of a \name section was not parsed.</li> -<li> Stars (*) at the start of a line in /**< ... */ style comments +<li> Stars (*) at the start of a line in /**< ... */ style comments after a parameter were included in the result.</li> <li> Putting a C-style comment in a @code block was not handled properly.</li> </ul> @@ -7896,7 +8066,7 @@ make sure you add the following: thanks to Ryunosuke Sato.</li> <li> Included update for Slovak translator, thanks to Stanislav Kudlac.</li> <li> Thanks to a patch by Pascal Flammant tables in the documentation - can now have captions using <caption> ... </caption> + can now have captions using <caption> ... </caption> within a table definition.</li> <li> A dash-style list can now be ended without ending the paragraph. See the list-section of the documentation for an example.</li> @@ -7905,10 +8075,10 @@ make sure you add the following: <h3>Changes</h3> <ul> <li> Changed the way @internal works. The "For internal use only" message, - now appears (along with the internal documentation) + now appears (along with the internal documentation) if and only if INTERNAL_DOCS = YES. </li> <li> Subgroups are no longer sorted but presented in declaration order.</li> -<li> Members inside todo/test/bug lists are now shown with qualified +<li> Members inside todo/test/bug lists are now shown with qualified names again. </li> <li> Reorganized the XML parser. It is now structured as a library, a header file, and a test application. See addon/doxmlparser for @@ -7916,11 +8086,11 @@ make sure you add the following: </ul> <h3>New features</h3> <ul> -<li> Included languages updates for French, Portuguese, +<li> Included languages updates for French, Portuguese, Korean, Italian, Dutch, Slovene, Brazil, German and Portuguese. - Thanks to Harry Kalogirou doxygen now has support for output in + Thanks to Harry Kalogirou doxygen now has support for output in the Greek language.</li> -<li> Included patch by Adam Doppelt to make doxysearch work +<li> Included patch by Adam Doppelt to make doxysearch work better with windows/IIS.</li> <li> Added more info to the XML output: include dependencies, member groups, re-implement relations, const/volatile specifiers, @@ -7928,7 +8098,7 @@ make sure you add the following: <li> Added some logic to deal with member specializations. They should now be added as additional members to a class instead of being ignored and producing a warning.</li> -<li> Thanks to a patch by Bruce Korb, author of +<li> Thanks to a patch by Bruce Korb, author of <a href="http://autogen.sourceforge.net/">autogen</a>, doxygen now has output support for producing autogen definition files. To do this set GENERATE_AUTOGEN_DEF to YES in the config file. </li> @@ -7941,7 +8111,7 @@ make sure you add the following: or hide classes and structs defined in source files.</li> <li> Thanks to an install script written by David Greig, the windows version of doxygen now comes with a windows installer based on - Jordan Russell's + Jordan Russell's <a href="http://www.jrsoftware.org/isinfo.htm">Inno Setup</a>.</li> </ul> @@ -7951,19 +8121,19 @@ make sure you add the following: <li> Auto detection of idl files was broken.</li> <li> Preprocessor did not parse hexadecimal values correctly.</li> <li> Fixed XML output problem (too many </highlight> tags).</li> -<li> Documentation for nested classes inside other nested classes was +<li> Documentation for nested classes inside other nested classes was not written to the output.</li> -<li> Fixed problem mixing paragraph commands (like \param) with +<li> Fixed problem mixing paragraph commands (like \param) with hyphen-style lists.</li> <li> Modules index in LaTeX was broken.</li> <li> STRIP_FROM_PATH now works for windows-style paths as well. Thanks to Joël Conraud for the patch.</li> -<li> For functions whose declaration was grouped and whose definition - contained a documentation block with a todo/test/bug item, +<li> For functions whose declaration was grouped and whose definition + contained a documentation block with a todo/test/bug item, the item did not appear in the todo/test/bug list.</li> <li> In the source browser output, the "=" in variable initializers was outputted as "==". </li> -<li> Fixed parse problem for typedefs of function pointers returning +<li> Fixed parse problem for typedefs of function pointers returning a template instance.</li> <li> Fixed bug in parsing method pointer function arguments of the form "void f(void (C::*m)() const)"</li> @@ -7972,36 +8142,36 @@ make sure you add the following: <h3>Changes</h3> <ul> <li> Improved the speed of the todo/test/bug list generation considerably.</li> -<li> The list of all members of a class now shows for each member, +<li> The list of all members of a class now shows for each member, the class in which the member is defined.</li> -<li> Rewrote a substantial part of the source code parser - (SOURCE_BROWSER = YES). It is now more context sensitive and +<li> Rewrote a substantial part of the source code parser + (SOURCE_BROWSER = YES). It is now more context sensitive and will generate more/better links.</li> </ul> <h3>New features</h3> <ul> <li> Added new option HIDE_UNDOC_RELATIONS that can be set to NO to show - any undocumented inheritance and usage relations from the various + any undocumented inheritance and usage relations from the various graphs.</li> <li> Included updates for translations to Chinese (thanks to Charlie Liu) Slovene (thanks to Matjaz Ostroversnik), Russian (thanks to Alexandr Chelpanov), Czech (thanks to Petr Prikryl) - and Croatian (thanks to Boris Bralo). Included Petr's translator + and Croatian (thanks to Boris Bralo). Included Petr's translator adapter simplifications. Included Latin2 patch by Mitja Udovc.</li> <li> Updated the graph legend page.</li> <li> Added option REFERENCES_RELATION that can be enabled in combination - with SOURCE_BROWSER to produce for each function - a list of all called/used members/functions/variables. - The reverse list can now be enabled/disabled using the + with SOURCE_BROWSER to produce for each function + a list of all called/used members/functions/variables. + The reverse list can now be enabled/disabled using the new REFERENCED_BY_RELATION option.</li> -<li> Added native support for typedefs of the form +<li> Added native support for typedefs of the form "typedef void (__stdcall *name)()", where __stdcall can be any identifier.</li> -<li> Included a patch by Stephen Goudge which adds an option +<li> Included a patch by Stephen Goudge which adds an option EXAMPLE_RECURSIVE to indicate whether or not example files should be searched recursively.</li> -<li> Included patch by Erik Zeek to add EOL translation to the +<li> Included patch by Erik Zeek to add EOL translation to the config file output.</li> <li> Doxygen now searches the current directory for source files if the INPUT and FILE_PATTERNS are empty (thanks to Johan Eriksson @@ -8014,20 +8184,20 @@ make sure you add the following: <ul> <li> Fixed more RTF problems and added an RTF integrity check that is performed on the generated RTF output (bracket matching).</li> -<li> Refined the macro detection in the preprocessor a little, so it does +<li> Refined the macro detection in the preprocessor a little, so it does not match constructors and functions so easily.</li> <li> the % prefix didn't work for scoped items.</li> <li> References to groups defined in tag files did not work.</li> <li> documentation for classes inside namespaces was generated multiple times.</li> -<li> Running doxytag on qt-3.0.0 resulted in a tag file containing +<li> Running doxytag on qt-3.0.0 resulted in a tag file containing non-breakable spaces.</li> <li> The \package statement did not work correctly for packages whose name contained a dot.</li> <li> Fixed Parser bug for java initializers of the form = "\"/*";</li> <li> Fixed LaTeX output problem when using \par followed by a (-) list.</li> <li> Fixed LaTeX output bug in the related page index.</li> -<li> Commands inside a conditional section would still appear in the +<li> Commands inside a conditional section would still appear in the result even if the section was disabled.</li> <li> Included idea by Roberto Bagnara to make running "make" in the LaTeX output autodetect how many times latex has to be run.</li> @@ -8072,14 +8242,14 @@ make sure you add the following: <ul> <li> The source browser option now generates links to (documented) globals and fields. Especially useful for C code.</li> -<li> Input containing CR+LF (DOS/Windows) or CR only (Mac) are now +<li> Input containing CR+LF (DOS/Windows) or CR only (Mac) are now automatically converted to LF. </li> <li> New config option SKIP_FUNCTION_MACROS that when set to YES - (the default) makes doxygen's preprocessor automatically remove all - function macros that are alone on a line and do not end with a - semicolon. These are typically used as boiler-plate code and + (the default) makes doxygen's preprocessor automatically remove all + function macros that are alone on a line and do not end with a + semicolon. These are typically used as boiler-plate code and confuse the parser if not removed.</li> -<li> Added class collaboration and inheritance diagram descriptions +<li> Added class collaboration and inheritance diagram descriptions to the XML output. Also added source browser output for each file.</li> <li> Added a developers part to the manual, with some information on how doxygen is structured internally.</li> @@ -8101,7 +8271,7 @@ make sure you add the following: <li> Fixed bug in RTF output (bracket mismatch).</li> <li> Initializer of the last enum value of an enum did not always appear.</li> <li> Dots were removed from return types in Java.</li> -<li> In some cases a broken "More..." link was generated after +<li> In some cases a broken "More..." link was generated after a brief class description.</li> <li> Text of a section title containing was truncated if it contained an asterix.</li> @@ -8110,7 +8280,7 @@ make sure you add the following: <li> Fixed generated makefile dependencies for USE_PDFLATEX = YES (thanks to Marcus Holland-Moritz)</li> <li> "\retval #VALUE" now links to VALUE if documented. The same works - for \exception and \throws + for \exception and \throws (and since the argument is a class no # is needed).</li> <li> Sorting the alphabetical list was broken for nested classes.</li> </ul> @@ -8120,12 +8290,12 @@ make sure you add the following: <li> Relations between templates and their instances are now visualized in the inheritance and collaboration graphs. Can be disabled by setting TEMPLATE_RELATIONS to NO in the config file.</li> -<li> A Java package can now be documented using a comment block containing a - @package command or by putting a documentation block in front of a +<li> A Java package can now be documented using a comment block containing a + @package command or by putting a documentation block in front of a package statement.</li> <li> Added new command \dotfile which can be used to include a user specified dot file as an image in the documentation. The new config - option DOTFILE_DIRS should be used to specify directories in which + option DOTFILE_DIRS should be used to specify directories in which doxygen should look for dot files (thanks to Samit Basu for the patch).</li> <li> Added new build target macosx-c++ to build doxygen for Mac OS X (Thanks to Jason Harris for telling me what needed to be changed).</li> @@ -8139,24 +8309,24 @@ make sure you add the following: <ul> <li> Fix compile problem for the Irix compiler (thanks to Dirk Reiners)</li> <li> Some generated &nsbp; entities where missing a ; in the HTML output. - For some browsers this resulted in argument types & names being + For some browsers this resulted in argument types & names being glued together.</li> <li> The heading of parameter and return value lists was not bold anymore in the HTML output. </li> <li> "Reimplemented to/from" member links now work between template base classes and their derived classes.</li> -<li> Not all documented templates class were regarded as documented +<li> Not all documented templates class were regarded as documented (unless EXTRACT_ALL was set to YES).</li> <li> Fixed recursive lock-up problem for recursive templates of the form: template<class T> class A : public A<typename T::B> {}</li> -<li> The labels in the alphabetical list were broken when namespaces were +<li> The labels in the alphabetical list were broken when namespaces were used.</li> <li> An error was given for import statements in Java sources.</li> <li> The "list of all members" was no longer generated for nested classes.</li> <li> Fixed bug in XML output causing mis matched <para> tags.</li> <li> Fixed parse problem for enum initializers like: "enumVal = A<T,C>::val" </li> <li> \hideinitializer did not hide the initializer of enum values.</li> -<li> Undocumented enums and enum values now behave correctly when +<li> Undocumented enums and enum values now behave correctly when HIDE_UNDOC_MEMBERS is set to YES.</li> <li> Fixed a problem with using \if inside alias definitions.</li> <li> Fixed & changed the layout of function arguments a little.</li> @@ -8165,14 +8335,14 @@ make sure you add the following: <li> Members of an unnamed namespace are now treated as static, and will only appear in the documentation if EXTRACT_STATIC is set to YES.</li> <li> Classes are sorted by their name, i.s.o. full scope again.</li> -<li> Improved argument matching for members defined within (nested) +<li> Improved argument matching for members defined within (nested) namespaces.</li> </ul> <h1>Doxygen Release 1.2.9.1</h1> <h3>Changes</h3> <ul> -<li> Bug/test/todo items of members are now grouped +<li> Bug/test/todo items of members are now grouped together with their compound.</li> </ul> <h3>New features</h3> @@ -8183,14 +8353,14 @@ make sure you add the following: <h3>Bug fixes</h3> <ul> <li> The .spec file still assumed the --with-xmlgen switch was available.</li> -<li> Template instances caused double entries in the class list +<li> Template instances caused double entries in the class list (in LaTeX) and broke RTF output.</li> <li> \if and \endif can now be used to make structural commands like \brief, \ingroup, and \defgroup conditional.</li> <li> The "const" in "func(B * const)" was parsed as a variable name.</li> <li> Template specializations of the form A<N::C> where not handled properly.</li> -<li> Putting \relates in a function documentation block that was +<li> Putting \relates in a function documentation block that was within a namespace, while referring to another namespace did not work.</li> <li> Doxywizard always complained it could not read the config file.</li> <li> Doxywizard did not properly update boolean and integer values.</li> @@ -8207,8 +8377,8 @@ make sure you add the following: <h3>Changes</h3> <ul> <li> Friend class declarations are now treated as normal members.</li> -<li> Completely rewrote the way templates are handled. - Doxygen now (internally) computes all template instantiations it encounters. +<li> Completely rewrote the way templates are handled. + Doxygen now (internally) computes all template instantiations it encounters. This has the following advantages: <ul> <li>Template instantiations are now shown in the hierarchical index @@ -8219,7 +8389,7 @@ make sure you add the following: Since there is a lot of new code, some more testing won't hurt to mature the code. If you are using templates, please try this version for me and report any problems.</li> -<li> Started moving the XML output generator back into doxygen. +<li> Started moving the XML output generator back into doxygen. As a result the GENERATE_XML option has reappeared.</li> <li> Function arguments names are now nicely aligned in the generated HTML output. Thanks to Joe Bester for doing most of the work. </li> @@ -8242,7 +8412,7 @@ make sure you add the following: <li> Linebreaks are now done with \par instead of \line in the RTF output (thanks to Henning Moll).</li> <li> Removed bogus warnings when parsing tag files.</li> -<li> The detailed description in a @name block can now be more than +<li> The detailed description in a @name block can now be more than plain text.</li> <li> Included fix for the tree view script for the Mozilla browser (thanks to Alec Panovici).</li> @@ -8258,22 +8428,22 @@ make sure you add the following: now work.</li> <li> "doxygen -g -s" now creates a file named Doxyfile i.s.o "-s" </li> <li> Fixed a null pointer referencing problem (thanks to Nick Pratt)</li> -<li> 8-bits characters are now correctly handled within the argument +<li> 8-bits characters are now correctly handled within the argument of \b, \c or \e.</li> <li> Reimplemented links were broken for grouped members (thanks to Johan Eriksson for the fix).</li> -<li> Enabling the Tree view didn't result in proper RTF and LaTeX output +<li> Enabling the Tree view didn't result in proper RTF and LaTeX output (thanks to Paul Sydney for the fix).</li> <li> Merged patches by Joe Bester: <ul> <li>Could not link to @anchors in the main page on external packages.</li> - <li> All external modules and pages were linked to or appended + <li> All external modules and pages were linked to or appended (even the TODO page, etc), even when EXTRACT_ALL is set to NO.</li> - <li> The section containing structs and unions is labeled - "Class Documentation" (in the English translation) even when + <li> The section containing structs and unions is labeled + "Class Documentation" (in the English translation) even when the OPTIMIZE_OUTPUT_FOR_C was set to YES.</li> </ul></li> -<li> using the IDL keyword "import" in other languages did not work +<li> using the IDL keyword "import" in other languages did not work correctly.</li> <li> members of a privately inherited base class were not shown in the list of all members, while they were accessible from the derived class.</li> @@ -8281,7 +8451,7 @@ make sure you add the following: capable of handling nested template classes correctly. Please test this if you are using these constructs. Thanks to Christoph Koegl for providing some difficult test cases.</li> -<li> Fixed parse problem when parsing << as part of the first +<li> Fixed parse problem when parsing << as part of the first argument of a typedef.</li> <li> Further improved typedef resolution.</li> <li> The LATEX_HEADER-config option disabled the \mainpage-output @@ -8305,7 +8475,7 @@ make sure you add the following: <h3>New features</h3> <ul> <li> Included update for Brazilian translation.</li> -<li> Add support for &lt; &gt; &amp; &apos; &quot; +<li> Add support for &lt; &gt; &amp; &apos; &quot; in the documentation, since these commands after occur in Java documentation.</li> </ul> @@ -8319,7 +8489,7 @@ make sure you add the following: <li> When a paragraph header was directly followed by an item list doxygen did not render the first item properly.</li> <li> The "More..." link was often omitted for grouped members. </li> -<li> "dangerous" characters like ":" are now escaped from man page +<li> "dangerous" characters like ":" are now escaped from man page file names</li> </ul> <h1>Doxygen Release 1.2.8</h1> @@ -8332,7 +8502,7 @@ make sure you add the following: <ul> <li> The dot generated inheritance and collaboration graphs for classes should now show the proper template instantiation for the derived/used - classes. For instance it should show that class S uses class V + classes. For instance it should show that class S uses class V (indirectly) in the following example: <pre> class V {}; @@ -8342,21 +8512,21 @@ make sure you add the following: template<class T> class B2 : public B1<T> {}; class S : public B2<V> {}; </pre> - Please report any example of class hierarchies that are not shown + Please report any example of class hierarchies that are not shown properly.</li> <li> Added doc/translator.pl script created by Petr Prikryl. Its main purpose is to extract information from doxygen's sources related to internationalization (i.e. the translator classes), to - avoid duplication of information (i.e. doc/language.doc is now + avoid duplication of information (i.e. doc/language.doc is now generated) and to generate reports about the status of the translations (e.g. missing methods). </li> <li> Stanislav Kudlac added support for Slovak language and Erik Søe Sørensen added support for Danish. - Applied language updates for + Applied language updates for Italian, Croatian, Spanish, Czech, German & Russian.</li> <li> Added support for "KBD" HTML tags (thanks to Albin Wu).</li> -<li> Added man patch by Patrick Ohly which allows to create freestyle - man pages using \page and puts man page with non-default extension +<li> Added man patch by Patrick Ohly which allows to create freestyle + man pages using \page and puts man page with non-default extension in the correct directory.</li> <li> Added MAN_LINKS option (thanks to Patrick Ohly for the patch).</li> <li> Added grouping patches by Patrick Ohly: @@ -8373,7 +8543,7 @@ make sure you add the following: doxygen will use the name as title (this is the old behavior). <pre> /** \addtogroup name */ - </pre> + </pre> can be used to add documentation or members to a group (as in 1.2.7), but the group is created if it doesn't exist yet. You can provide the title later @@ -8390,7 +8560,7 @@ make sure you add the following: </p> <p> \weakgroup is exactly the same as \addtogroup, but if a member - is put into such a group with <code>\weakgroup name @{ @}</code> + is put into such a group with <code>\weakgroup name @{ @}</code> and into another group with <code>\[def|addto]group @{ @}</code>, then it will be placed into the other group without issuing a warning. @@ -8421,18 +8591,18 @@ make sure you add the following: <li> Fixed a bug in the LaTeX output generation (empty lists).</li> <li> Doxygen can now distinguishing f(const A) from f(const B) even though they match from a syntactical point of view.</li> -<li> A template base class that is actually an inherited template - argument of the derived class is no longer shown in the output +<li> A template base class that is actually an inherited template + argument of the derived class is no longer shown in the output indices and hierarchies.</li> <li> TOC_EXPAND could result in a broken tree view (patch by Alexandr Chalpanov).</li> -<li> If a base class had member names which has the same name as enumerator - values in a derived class, the enumerator values did not show up in +<li> If a base class had member names which has the same name as enumerator + values in a derived class, the enumerator values did not show up in the documentation (thanks to John Harris for reporting this).</li> <li> Applied a number of patches sent by Jens Seidel.</li> <li> Fixed compiler limit problem on Windows (thanks to Trevor Robinson).</li> -<li> Add -dBATCH in system calls to ghostscript (needed for formulas) - to avoid a command prompt for newer versions of ghostscript +<li> Add -dBATCH in system calls to ghostscript (needed for formulas) + to avoid a command prompt for newer versions of ghostscript (thanks to Marvin Wolfthal).</li> <li> In some situations doxygen wanted to write a files containing a \n.</li> <li> Environment variables can now also be used for non-string values @@ -8449,21 +8619,21 @@ make sure you add the following: <h1>Doxygen Release 1.2.7</h1> <h3>Changes</h3> <ul> -<li> The configgen tool is now replaced by a more dynamic parser. This - will allow future output generators to add specific options without - changing or recompiling the doxygen engine. Doxywizard has also been - updated to use this new parser. Developers that wish to add new +<li> The configgen tool is now replaced by a more dynamic parser. This + will allow future output generators to add specific options without + changing or recompiling the doxygen engine. Doxywizard has also been + updated to use this new parser. Developers that wish to add new configuration options, please look at Config::create() in src/config.l</li> <li> Changed the way the translators work internally (thanks to Petr - Prikryl for ideas and code) and updated the documentation regarding - language support and maintenance. Users of languages other than - English will get a warning message if the translation for their + Prikryl for ideas and code) and updated the documentation regarding + language support and maintenance. Users of languages other than + English will get a warning message if the translation for their language is not up to date.</li> -<li> Did some internal cleaning up to make things - more consistent and easier to maintain. Please let me know if you +<li> Did some internal cleaning up to make things + more consistent and easier to maintain. Please let me know if you think something has been broken in the process. </li> <li> Doxygen now uses a more unique output file name mangling scheme, which - generates unique file names even if entity names (like class names) + generates unique file names even if entity names (like class names) only differ in case.</li> <li> Setting ALLEXTERNALS = NO now hides external pages in the page index.</li> </ul> @@ -8473,17 +8643,17 @@ make sure you add the following: <li> \image is now supported for RTF output (thanks to Joe Ninety).</li> <li> New RTF_EXTENSIONS_FILE that can be used to configure the RTF output (thanks to Joe Ninety for the patch).</li> -<li> Added new command \htmlinclude that can be used to include a - HTML file as is in the HTML documentation. +<li> Added new command \htmlinclude that can be used to include a + HTML file as is in the HTML documentation. (thanks to Uwe Wojak for the patch)</li> -<li> &nbsp; can now be put in the documentation to force a +<li> &nbsp; can now be put in the documentation to force a non-breakable space.</li> <li> Included support for the gcc extension #include_next (thanks to Jac Goudsmit for the patch). </li> -<li> Included translation for Brazilian Portuguese sent by Fabio Jun - Takada Chino. Add update for the Czech translation - (thanks to Petr Prikryl). Also included updates for German - (thanks to Jens Seidel), Russian (thanks to Alexandr Chelpanov) and +<li> Included translation for Brazilian Portuguese sent by Fabio Jun + Takada Chino. Add update for the Czech translation + (thanks to Petr Prikryl). Also included updates for German + (thanks to Jens Seidel), Russian (thanks to Alexandr Chelpanov) and Croatian (thanks to Boris Bralo).</li> <li> Added RPM spec file update by Jens Seidel.</li> <li> Added SHORT_NAMES option which can be set to YES to make doxygen @@ -8500,12 +8670,12 @@ make sure you add the following: that fixes this).</li> <li> Specifying a directory at the INPUT that ends with a \ did not make doxygen recurse the down the directory tree in Windows.</li> -<li> Fixed two small bugs that caused segfaults on +<li> Fixed two small bugs that caused segfaults on NetBSD and Linux on 64bit Alpha's (thanks to Rex McMaster and Ovidiu Toader).</li> -<li> "Referenced by" section now starts at a new paragraph +<li> "Referenced by" section now starts at a new paragraph (thanks to Joe Ninety).</li> -<li> Setting OPTIMIZE_OUTPUT_FOR_C still produced some C++-ish +<li> Setting OPTIMIZE_OUTPUT_FOR_C still produced some C++-ish sentences for the list of all struct/union fields.</li> <li> Undocumented friend functions were listed as friend classes.</li> <li> A CORBA IDL union with a switch was not always recognized correctly. </li> @@ -8523,11 +8693,11 @@ make sure you add the following: <li> Generated bookmarks in the RTF output not starting with a letter caused problems (thanks to Jonathan Beaupre for the fix).</li> <li> Putting &aring; in the docs wasn't working as expected.</li> -<li> Fixed a number of typo's in the docs (thanks to Jens Seidel and +<li> Fixed a number of typo's in the docs (thanks to Jens Seidel and Philippe Lhoste).</li> <li> Autolinking could create links inside user defined HTML links.</li> -<li> Email addresses in the docs starting with an "a" and put inside sharp - brackets were not properly displayed (thanks to Abramo Bagnara for +<li> Email addresses in the docs starting with an "a" and put inside sharp + brackets were not properly displayed (thanks to Abramo Bagnara for the fix).</li> <li> Fix several man page output bugs (thanks a patch by Patrick Ohly). </li> </ul> @@ -8549,7 +8719,7 @@ make sure you add the following: (default is NO).</li> <li> Added option DOT_CLEANUP that when set to NO leaves the intermediate dot files in the output directory.</li> -<li> Added option BINARY_TOC to enable/disable use of a binary table of +<li> Added option BINARY_TOC to enable/disable use of a binary table of contents in a .chm file (thanks to Martin Slater for the patch).</li> <li> Added option TOC_EXPAND to when enabled shows the members of a group in the treeview and HTML help table of contents (thanks again @@ -8557,11 +8727,11 @@ make sure you add the following: <li> Included group support for man page output (thanks to Joe Bester for the patch).</li> <li> Added option SHOW_USED_FILES that can be used to disable the - list of used files normally generated at bottom of the documentation + list of used files normally generated at bottom of the documentation of classes and structs (thanks to Joe Bester).</li> -<li> Updated the doxbar tool: +<li> Updated the doxbar tool: <ul> - <li> the addin no longer requires administrator privileges to work + <li> the addin no longer requires administrator privileges to work (thanks to Michael Beck)</li> <li> the existence of files is now checked (thanks to Pekka Pessi).</li> <li> .odl and .inl files are recognized (thanks to Pekka Pessi).</li> @@ -8579,29 +8749,29 @@ make sure you add the following: <li> Fixed IDL union parse problem (thanks to Richard Hash).</li> <li> Latex output sometimes contained $\ast$ for code fragments.</li> <li> lonely *'s were not removed inside a <pre> and <code> blocks. </li> -<li> Applied patch sent by Joe Bester to make the treeview +<li> Applied patch sent by Joe Bester to make the treeview javascript work with Mozilla. Still has some problems though.</li> <li> Fixed a bug in code parser regarding string detection, inside the argument list of a function.</li> <li> Using a command alias starting with \class (or other structural commands) did not give the expected result.</li> -<li> A function pointer returned as the template argument of a template - class that itself is the return type of a function was not +<li> A function pointer returned as the template argument of a template + class that itself is the return type of a function was not parsed properly.</li> <li> In IDL, typedef's followed by an attribute list where not parsed properly. </li> -<li> The list of all members now shows all privately accessible members +<li> The list of all members now shows all privately accessible members if EXTRACT_PRIVATE is set to YES, instead of just the non-inherited private members.</li> <li> Fixed autolink problem for grouped members.</li> <li> Multiple static global functions with the same name (but in different - files), which were forward declared, could make doxygen put + files), which were forward declared, could make doxygen put the wrong documentation block at the wrong global function.</li> <li> Support for Norwegian was not enabled.</li> <li> The correct charset is now set when the treeview is used (thanks to Boris Bralo).</li> <li> For inline source fragments of member functions, the types - of the arguments are now also taken into account for + of the arguments are now also taken into account for cross-referencing.</li> <li> A sentence ending with a dot, directly followed by a \n was not handled correctly.</li> @@ -8618,7 +8788,7 @@ make sure you add the following: <li> Todo items in the documentation of grouped members were not correctly referenced from the todo list.</li> <li> Removed bogus "a" entries from appearing in doxysearch's search results.</li> -<li> Putting <a href="..."><img src="..."></a> in the +<li> Putting <a href="..."><img src="..."></a> in the docs will now work as expected for HTML.</li> <li> Fixed problems with >pre>...>/pre> block in LaTeX.</li> <li> Putting &ccedil; in the docs now produces a c-cedille.</li> @@ -8634,7 +8804,7 @@ make sure you add the following: (see addon/xmlgen).</li> <li> Having SOURCE_BROWSER set to YES does not automatically imply that a member is documented.</li> -<li> Typedefs of classes are now shown in (dot) inheritance graphs with +<li> Typedefs of classes are now shown in (dot) inheritance graphs with their typedef name instead of the resolved name.</li> <li> Upgraded Qt files to 2.2.3 to fix some compile issues.</li> </ul> @@ -8643,12 +8813,12 @@ make sure you add the following: <ul> <li> Added initial support for Java. The parsing of Java code should be ok. There is a new "packages" index, with a list - of all parsed Java packages, each of which can be documented - (but not yet in the Java way using package.html) and contains - links to the interfaces and classes in the package. The code - parser still needs work (It doesn't do much cross-referencing yet). + of all parsed Java packages, each of which can be documented + (but not yet in the Java way using package.html) and contains + links to the interfaces and classes in the package. The code + parser still needs work (It doesn't do much cross-referencing yet). Also any explicit package scope for classes is basically ignored, - so you cannot have two classes with the same name in different + so you cannot have two classes with the same name in different packages. Let me know if you know of other improvements.</li> <li> Added support for the Java style of linking (using @@ -8660,7 +8830,7 @@ make sure you add the following: <li> OPTIMIZE_OUTPUT_FOR_C flag that when set to YES makes doxygen produce output that looks more natural for C programmers.</li> <li> Included Czech language update sent by Petr Prikryl. </li> -<li> Added "Binary TOC=YES" and "Create CHI file=YES" to the HtmlHelp +<li> Added "Binary TOC=YES" and "Create CHI file=YES" to the HtmlHelp project file for better integration with MSDN.</li> <li> I've updated the doxbar tool: <ul> @@ -8682,7 +8852,7 @@ make sure you add the following: <li> Links to operators in a "See also" section did only work if the arguments list was given.</li> <li> Fixed parse bug in the code parser for the case where "<" - and ">" were found on a line but couldn't possibly be a + and ">" were found on a line but couldn't possibly be a template scope.</li> <li> The "More..." links was incorrect for members of class grouped with @ingroup.</li> @@ -8694,16 +8864,16 @@ make sure you add the following: <li> Local references to page anchors did not work.</li> <li> Windows only: doxygen leaked process handles while running dot (thanks to Jeroen ter Hofstede for the fix).</li> -<li> Undefining (with #undef) a define set using PREDEFINED now +<li> Undefining (with #undef) a define set using PREDEFINED now longer has an effect.</li> <li> Functions appeared twice in modules if the prototype and definition did not match exactly.</li> <li> the word "operator" in todo items caused problems.</li> -<li> Fixed some more problems with references to external pages, - local references to sections, and naming conflicts with multiple +<li> Fixed some more problems with references to external pages, + local references to sections, and naming conflicts with multiple todo/test lists.</li> <li> "char a:1, b:2" resulting in output including both bitfields for b.</li> -<li> The protection level of the members in the all-member list was not +<li> The protection level of the members in the all-member list was not always correct.</li> <li> Fixed some typos in the Dutch and German translations.</li> <li> \todo's in the docs of #define did not end up on the todo list.</li> @@ -8724,10 +8894,10 @@ make sure you add the following: description in the compound list. </li> <li> User defined groups (a.k.a. modules) are now shown in a hierarchy.</li> <li> If a function and its prototype are both inside different documented - files then they may both be documented separately and will appear - as such in their file documentation + files then they may both be documented separately and will appear + as such in their file documentation If you only document the header file and not the source - file you can still put your documentation in front of the function + file you can still put your documentation in front of the function definition as before.</li> <li> For unresolved base classes of a class inside a namespace, doxygen now guesses they are defined outside the namespace (was inside).</li> @@ -8738,28 +8908,28 @@ make sure you add the following: <h3>New features</h3> <ul> <li> There is now an HTML Help like tree view, that can be enabled - by setting GENERATE_TREEVIEW to YES. + by setting GENERATE_TREEVIEW to YES. This feature requires a browser that supports frames and javascript. - Note that frame/page-resizing requires a manual reload with + Note that frame/page-resizing requires a manual reload with Netscape 4.x at the moment (it is a known netscape bug). (thanks to Ken Wong for providing the code to generate the tree in the proper format).</li> <li> Added new option TREEVIEW_WIDTH that can be used to set the initial with of the treeview frame.</li> -<li> A warning is now generated for invalid \link targets +<li> A warning is now generated for invalid \link targets (again thanks to Ken Wong).</li> <li> Wang Weihan sent an update for the Chinese translation which is now included. Included update for the Russian and Italian language as well.</li> -<li> Support for Borland C++ and MINGW compilers for Windows +<li> Support for Borland C++ and MINGW compilers for Windows (thanks to Oliver Brandt for the patch). </li> <li> Groups and pages defined in external documentation (i.e. with tag files) can now be referenced using \ref.</li> <li> Pages can now be put into groups using \ingroup (thanks to Ken Wong). - A group with only pages is rendered as a page (the group itself) + A group with only pages is rendered as a page (the group itself) with subsections (the inserted pages). </li> <li> \ingroup can now be put in a one line comments (thanks to Patrick Ohly)</li> -<li> \ingroup in a comment block before a comma separated list of - variables is now applied to all variables (as is the documentation +<li> \ingroup in a comment block before a comma separated list of + variables is now applied to all variables (as is the documentation itself). (thanks to Patrick Ohly for the patch)</li> <li> @{ .. @} blocks can now be used for normal groups as well (thanks to Trevor Robinson for the patch). Here is an example: @@ -8769,7 +8939,7 @@ make sure you add the following: * @{ */ - /** @name My member group + /** @name My member group * @{ */ /** This is a function */ @@ -8799,9 +8969,9 @@ make sure you add the following: <ul> <li> If source files were put in the input before header files, the - declaration against definition matching did not work for + declaration against definition matching did not work for global functions (thanks to Frank Warmerdam for reporting this). </li> -<li> The template argument type and name of template functions +<li> The template argument type and name of template functions were not separated by a space.</li> <li> A comma separated list of member reference variables (like int &i,&j;) was not parsed correctly.</li> @@ -8814,7 +8984,7 @@ make sure you add the following: definition.</li> <li> REPEAT_BRIEF = NO now works for class, namespace and file documentation as well.</li> -<li> No macro-expansion was done on a file that was #include'd in a body +<li> No macro-expansion was done on a file that was #include'd in a body of a class or enum.</li> <li> Fixed macro concatenation bug in the preprocessor.</li> <li> Global functions that were \ingroup'd could appear twice in a group @@ -8822,7 +8992,7 @@ make sure you add the following: <li> % and & can now be used in the URL in the documentation.</li> <li> \c,\e and \b now also generate a link if they have the name of a documented file as their argument.</li> -<li> Made the FILTER_SOURCE_FILES actually do something +<li> Made the FILTER_SOURCE_FILES actually do something (it was always treated as enabled).</li> <li> Fixed two bugs in the autolist feature (thanks to Ken Wong)</li> <li> Fix macro expansion bug in the preprocessor, when macro's @@ -8830,16 +9000,16 @@ make sure you add the following: <li> // did not work inside the argument of a \todo or \test command. </li> <li> Doxygen did not parse arrays of function pointers properly.</li> <li> Fixed parse bug for templates with nested template arguments.</li> -<li> Fixed parsing problem for template arguments +<li> Fixed parsing problem for template arguments containing << or >> operators</li> <li> Fixed some problems with the DOT_PATH config option on windows.</li> <li> Group title and file names are now shown in the latex index instead of the label names.</li> -<li> Portability: Added workaround for SGI MipsPro compiler, that - (hopefully) prevents it from crashing while compiling doxygen. +<li> Portability: Added workaround for SGI MipsPro compiler, that + (hopefully) prevents it from crashing while compiling doxygen. Worked around a number of compile problems with HP's C++ compiler.</li> <li> Fixed problem with doxygen calling epstopdf.bat in Windows.</li> -<li> Fixed some problems that occurred when regenerating the +<li> Fixed some problems that occurred when regenerating the doxygen manual on Windows.</li> <li> Fixed some output formatting problems regarding templates. </li> <li> Global functions, typedefs, and enums did not get linked when @@ -8856,10 +9026,10 @@ make sure you add the following: <li> <code>JAVADOC_AUTOBRIEF</code> is now set to NO by default, because too many people expect the JavaDoc-style to behave as the Qt-style and not in the way described in the JavaDoc spec.</li> -<li> The distribution now includes the part of Qt-2.2.0 that is needed for - compilation of doxygen, doxytag, and doxysearch. I've also created the - missing files for Windows. This allows compilation of doxygen on systems - without X11 or the full Qt. For doxywizard Qt-2.2.x is still required +<li> The distribution now includes the part of Qt-2.2.0 that is needed for + compilation of doxygen, doxytag, and doxysearch. I've also created the + missing files for Windows. This allows compilation of doxygen on systems + without X11 or the full Qt. For doxywizard Qt-2.2.x is still required however.</li> </ul> <h3>New features</h3> @@ -8874,48 +9044,48 @@ make sure you add the following: sections. (__published: is just treated as public:).</li> <li> Included update for the Czech language. Thanks to Wang Weihan there is also support for Chinese output now.</li> -<li> Added a config option <code>WARN_LOGFILE</code> to log warnings to a +<li> Added a config option <code>WARN_LOGFILE</code> to log warnings to a file for those - people that have to use certain "operating systems" that do not support + people that have to use certain "operating systems" that do not support redirection of stderr to file.</li> <li> Added a config option <code>GENERATE_LEGEND</code> that can be used to disable the legend page normally generated for explaining dot graphs.</li> <li> Thanks to a patch send by Micha Bieber, doxygen can now be run from inside doxywizard.</li> -<li> Environment variables can now be used in the <code>@INCLUDE_PATH</code> - and <code>@INCLUDE</code> tags in the config file (thanks to Stephen +<li> Environment variables can now be used in the <code>@INCLUDE_PATH</code> + and <code>@INCLUDE</code> tags in the config file (thanks to Stephen Goudge).</li> <li> Windows compilation/installation instructions are updated (thanks to Petr Prikryl)</li> -<li> New config tag <code>ENUM_VALUES_PER_LINE</code> to set the number of +<li> New config tag <code>ENUM_VALUES_PER_LINE</code> to set the number of enum values that are grouped on one line (default=4).</li> <li> #include's inside the body of a class are now expanded. </li> -<li> The source browser files can now by filtered using the - <code>INPUT_FILTER</code> if <code>FILTER_SOURCE_FILES</code> is set +<li> The source browser files can now by filtered using the + <code>INPUT_FILTER</code> if <code>FILTER_SOURCE_FILES</code> is set to YES (thanks to Paul Strauss).</li> </ul> <h3>Bug fixes</h3> <ul> <li> For #foo in member documentation doxygen was trying to find a global variable named foo instead of a member. Use ::foo - to make an explicit link to a global variable in case there is + to make an explicit link to a global variable in case there is also a member named foo. </li> <li> A bullet list ending with a \par sometimes caused the paragraph to be indented.</li> <li> When <code>STRIP_CODE_COMMENTS</code> was set to NO, and /*!< .. */ style comments were used, the code parser got out of sync with the documentation parser.</li> -<li> (Hopefully) fixed some Solaris compile problems +<li> (Hopefully) fixed some Solaris compile problems (thanks to John Sturton).</li> <li> documentation for private slots appeared in the documentation even though <code>EXTRACT_PRIVATE</code> was set to NO.</li> -<li> \relates was not working for nested classes or classes defined +<li> \relates was not working for nested classes or classes defined within a namespace.</li> <li> namespace alias support was broken with respect to inheritance relations containing aliased namespace names.</li> -<li> The documentation of members that are put into a - group (with \ingroup) is now removed from the natural +<li> The documentation of members that are put into a + group (with \ingroup) is now removed from the natural container of the member. Also the links are now corrected.</li> <li> Links from the code parser to static global functions are now always pointing to the correct file (thanks to Bill Soudan @@ -8929,14 +9099,14 @@ make sure you add the following: <li> Doxygen no longer generates source files for input files that end with .doc or .txt</li> <li> Fixed argument matching problem that could result in parameter name - changes for overloaded functions. Also fixed buglet for + changes for overloaded functions. Also fixed buglet for matching things like "unsigned int" against "unsigned int name"</li> <li> Fixed qtools compile problem with ./configure --english-only problem</li> <li> Putting documentation between the class and its body now also works if the class has base classes.</li> -<li> Fixed parse problem for const function pointers like +<li> Fixed parse problem for const function pointers like "int* (* const name)(long);"</li> -<li> Slightly changed the HTML output to work around display "bugs" in +<li> Slightly changed the HTML output to work around display "bugs" in Konquerer and Opera (thanks to Achim Spangler).</li> <li> Examples in compress HTML help of doxygen's manual has absolute links.</li> </ul> @@ -8945,7 +9115,7 @@ make sure you add the following: <h3>Changes</h3> <ul> <li> Verbatim headers are now also created if a documented header - file does not contain a struct or class (unless VERBATIM_HEADERS = NO + file does not contain a struct or class (unless VERBATIM_HEADERS = NO of course).</li> <li> For member groups, where only the first member is documented, that documentation is no longer automatically copied to all other @@ -8956,15 +9126,15 @@ make sure you add the following: <h3>New features</h3> <ul> <li> Added support for KDE-2 IDL (more specific: k_dcop member sections).</li> -<li> New ALIASES config option which allows you to add one or more user - defined aliases (a.k.a. macros) that can be used as commands in the +<li> New ALIASES config option which allows you to add one or more user + defined aliases (a.k.a. macros) that can be used as commands in the documentation. For instance: <pre> ALIASES = "sideeffect=\par Side Effects:\n" </pre> allows you to put @sideeffect in the documentation, which doxygen - will replace by "\par Side Effects:", before parsing. As a result - a formatted paragraph with a "Side Effects" header will appear. + will replace by "\par Side Effects:", before parsing. As a result + a formatted paragraph with a "Side Effects" header will appear. Note that the \n's are replaced by real newlines, so in the example you can put your paragraph text directly after the sideeffect command.</li> <li> Added language support for Hungarian (Thanks to György Földvári), @@ -8974,14 +9144,14 @@ make sure you add the following: <li> Added support for namespace aliases.</li> <li> Added RTF patch from Alexander Bartolich. Here is his description of the changes: - "The following patch of rtfgen.cpp allows to read *complete* style - definitions from rtfstyle. This includes \sbasedon, \snext, \additive + "The following patch of rtfgen.cpp allows to read *complete* style + definitions from rtfstyle. This includes \sbasedon, \snext, \additive and actual style names. If this data is missing the default value is used. This means old rtfstyle-files can be used without change, with one exception: - Reset is no longer considered a style. Since unknown style names + Reset is no longer considered a style. Since unknown style names are simply ignored I don't consider this a big problem. There is no means to write rtfstyle in old format, however. "</li> @@ -8991,12 +9161,12 @@ make sure you add the following: <h3>Bug fixes</h3> <ul> <li> RTF output was broken w.r.t. dot generated images. </li> -<li> Spacing and blanks inside <pre> ... </pre> block were not +<li> Spacing and blanks inside <pre> ... </pre> block were not properly preserved.</li> <li> Fixed lock-up when parsing "enum A { A };"</li> <li> If INLINE_INFO was set to NO an empty property list could be put after the function definitions.</li> -<li> Fixed source code linking for the following cases: +<li> Fixed source code linking for the following cases: <code>A::func().func2()</code> and <code>a[2]->func()</code>.</li> <li> \em %className did not remove the %</li> @@ -9004,7 +9174,7 @@ make sure you add the following: documentation.</li> <li> Fixed a bug in the auto list generation.</li> <li> \latexonly inside brief description did not work properly.</li> -<li> "Referenced By" list did not include constructors with +<li> "Referenced By" list did not include constructors with inline initializers.</li> <li> &auml; and such were not parsed when used as the argument of a section.</li> <li> A struct inheriting from a base class was marked as private inheritance @@ -9012,7 +9182,7 @@ make sure you add the following: <li> The autobreak routine for long return types was sometimes skipping characters. </li> <li> Class usage relations should now also appear in the collaboration - diagrams for classes within the same namespace, without explicitly + diagrams for classes within the same namespace, without explicitly having to mention the namespace.</li> </ul> @@ -9028,23 +9198,23 @@ make sure you add the following: item indicating where the todo item was found. The todo list (and all todo items) can be disabled by setting GENERATE_TODOLIST to NO.</li> <li> <pre> ... </pre> blocks now behave as in plain HTML instead of - \code ... \endcode blocks. This also works for LaTeX of course. - These blocks differ from \verbatim ... \endverbatim blocks in that + \code ... \endcode blocks. This also works for LaTeX of course. + These blocks differ from \verbatim ... \endverbatim blocks in that commands can be used inside these blocks.</li> </ul> <h3>New features</h3> <ul> -<li> Added rudimentary support for XML output. Still very much work in +<li> Added rudimentary support for XML output. Still very much work in progress... You can enable it by setting GENERATE_XML to YES. - There is a small utility (based on Qt & Xerces-C) in addon/xmlread - that uses the SAX interface to read a generated XML file and then dumps + There is a small utility (based on Qt & Xerces-C) in addon/xmlread + that uses the SAX interface to read a generated XML file and then dumps the class hierarchy contained in it.</li> <li> Thanks to a patch sent by Christophe Prud'homme, doxygen now has a new option USE_PDFLATEX that when set to YES makes doxygen use pdflatex instead of latex to generate refman.pdf. The result is a document with higher quality fonts.</li> -<li> Added a \test command that works similar to \todo and can be used to - describe test cases. Doxygen will generate a page containing a list +<li> Added a \test command that works similar to \todo and can be used to + describe test cases. Doxygen will generate a page containing a list of all test cases. To disable the list set GENERATE_TESTLIST to NO. Thanks to Dave Murrell for the idea and the initial code.</li> <li> For each list option in the config file += can now be used to append @@ -9067,42 +9237,42 @@ make sure you add the following: </pre> Credits go to Joerg Baumann.</li> <li> Included French and Czech language updates from Mathieu Despriée and - Petr Prikryl. Also included a language update for German from + Petr Prikryl. Also included a language update for German from Raimund Klein.</li> -<li> Doxygen will now do give proper warnings for formulas that do not +<li> Doxygen will now do give proper warnings for formulas that do not end properly.</li> <li> Improved error reporting for illegal list combinations (thanks to Joerg Baumann for the patch)</li> -<li> Comments from the code example in the dot graph "legend page" was +<li> Comments from the code example in the dot graph "legend page" was stripped if STRIP_CODE_COMMENTS was set to YES.</li> <li> In the config file "@INCLUDE = file" can now be used to include part of a configuration file. "@INCLUDEPATH = dir1 dir2 ..." can be put in front of it to add search paths (default is $PWD). Thanks to Joerg Baumann for the patch.</li> -<li> Added alphabetical quick indices for compound, file and namespace +<li> Added alphabetical quick indices for compound, file and namespace member lists.</li> </ul> <h3>Bug fixes</h3> <ul> <li> Running ghostscript on Windows for generating formulas was done asynchronously, resulting in ghostscript trying to access temporary - files that may already have been deleted by doxygen. Thanks to Robert + files that may already have been deleted by doxygen. Thanks to Robert Golias for the code to fix this.</li> <li> Include dependency graphs failed to get included in LaTeX because - \includegraphics did not like the dots in the generated file names. + \includegraphics did not like the dots in the generated file names. Those dots are now escaped by underscores.</li> -<li> The \remark did not end a brief description in JavaDoc comments, +<li> The \remark did not end a brief description in JavaDoc comments, resulting in a error in the generated LaTeX.</li> -<li> "<code>operator >></code>" was not matched against +<li> "<code>operator >></code>" was not matched against "<code>operator>></code>" </li> <li> the (required) space after \addindex ended up in the LaTeX index, causing all generated entries to be placed after the user added entries.</li> -<li> "<code>typedef class A<B> a;</code>" is now correctly handled in inheritance +<li> "<code>typedef class A<B> a;</code>" is now correctly handled in inheritance relations. </li> <li> Fixed some typos in the manual</li> <li> <code>\c Class::func(arg)</code> was not autolinked.</li> <li> Doxygen stopped reading from stdin after 4096 bytes.</li> -<li> In code fragments no autolinks for local variables or +<li> In code fragments no autolinks for local variables or dereferenced arguments were generated for template classes.</li> <li> autolinking to a namespace member foo from within a class scope also having a member foo did not work. </li> @@ -9114,18 +9284,18 @@ make sure you add the following: \textwidth as the width or height. </li> <li> After expanding an environment variable in the config file, the next environment variable was searched starting at the wrong position.</li> -<li> Fixed LaTeX/RTF labelname collisions between members of files and +<li> Fixed LaTeX/RTF labelname collisions between members of files and groups, and between classes and groups with the same name.</li> -<li> HTML image map partly appeared in RTF output when built-in class +<li> HTML image map partly appeared in RTF output when built-in class diagrams were used causing the RTF file to be truncated.</li> <li> Inheritance relation was not determined correctly in case a base class was imported from another namespace via a using declaration.</li> -<li> Todo and test items defined with \class or related block, where +<li> Todo and test items defined with \class or related block, where sometimes missing from The todo & test</li> -<li> Preprocessor: Multi-line #define's where not properly parsed & colored +<li> Preprocessor: Multi-line #define's where not properly parsed & colored on windows due to \r's</li> -<li> Preprocessor: expansion of <code>M(x)A</code>, where M is a macro - that expands to mx, resulted in +<li> Preprocessor: expansion of <code>M(x)A</code>, where M is a macro + that expands to mx, resulted in "<code>mxA</code>", instead of "<code>mx A</code>"</li> <li> Fixed compile problem with Qt-2.2.0beta1</li> </ul> @@ -9135,8 +9305,8 @@ make sure you add the following: <h3>Changes</h3> <ul> <li> <code>CASE_SENSE_NAMES</code> is now enabled by default.</li> -<li> In LaTeX <code>.eps</code> images are now included using the - graphicx package instead of epsfig to simplify the use of pdflatex +<li> In LaTeX <code>.eps</code> images are now included using the + graphicx package instead of epsfig to simplify the use of pdflatex (thanks to Pier Giorgio for showing me how that works).</li> <li> Reimplemented the <code>system()</code> call for Unix, so doxygen becomes interruptible when calling external tools such as dot.</li> @@ -9147,35 +9317,35 @@ make sure you add the following: <ul> <li> Grzegorz Kowal added support for the Polish language. His patch is now included. </li> -<li> A <code>\par</code> command without title argument can now be used to +<li> A <code>\par</code> command without title argument can now be used to add a new paragraph with the same indent under the heading of - another command (such as <code>\par</code>, <code>\param</code>, + another command (such as <code>\par</code>, <code>\param</code>, <code>\note</code>, etc...) </li> <li> Added a legend page explaining the various arrows and box colorings for the class diagrams generated by dot.</li> <li> Merged update for Croatian language.</li> -<li> Relative paths are now also allowed for the +<li> Relative paths are now also allowed for the <code>STRIP_FROM_PATH</code> tag.</li> <li> Added a new section to the manual explaining the use of tag files - in more detail. Also move the contents of the INSTALL file into + in more detail. Also move the contents of the INSTALL file into the "installation" section of the manual.</li> -<li> Added <code>ps_2on1</code> and <code>pdf_2on1</code> targets to the +<li> Added <code>ps_2on1</code> and <code>pdf_2on1</code> targets to the Makefile generated in the - LaTeX directory. These can be used to generate manual with 2 + LaTeX directory. These can be used to generate manual with 2 logical pages on 1 physical pages (Thanks to Onno).</li> <li> Merged Czech language update from Petr Prikryl. Merged Spanish language update sent by Lucas Cruz. </li> -<li> Added standard GNU long options <code>--help</code> and +<li> Added standard GNU long options <code>--help</code> and <code>--version</code>.</li> -<li> Added a <code>-w</code> option that can be used to generate template +<li> Added a <code>-w</code> option that can be used to generate template style sheet files for RTF, HTML, Latex. Thanks to Alexander Bartolich for the idea and part of the implementation.</li> <li> Merged patch from Steve Hespelt, which adds a new configuration - option: <code>INCLUDE_FILE_PATTERNS</code>. This tag can be used to - set the file patterns for the include files (if left empty the - <code>FILE_PATTERNS</code> will be used, which was also the old + option: <code>INCLUDE_FILE_PATTERNS</code>. This tag can be used to + set the file patterns for the include files (if left empty the + <code>FILE_PATTERNS</code> will be used, which was also the old behaviour). </li> -<li> Added a couple of commands for kdoc compatibility: <code>@p</code>, +<li> Added a couple of commands for kdoc compatibility: <code>@p</code>, <code>@li</code>, <code>@em</code>. Also made @ref a bit less strict.</li> <li> Portuguese translation by Rui Lopes. </li> @@ -9189,14 +9359,14 @@ make sure you add the following: class B { public: - void (B::*pmf)(); + void (B::*pmf)(); }; /*! \var void (B::*B::pmf)() * docs for this class member. */ </pre> - + did not work.</li> <li> Library blocks inside M$-IDL files are now also processed (a library is treated as a namespace at the moment). </li> @@ -9213,9 +9383,9 @@ make sure you add the following: <li> Fixed some compiler warning on Solaris.</li> <li> Changed grey by grey50 in dot.cpp to avoid PDF conversion problems.</li> <li> A </pre> that was not preceded by a whitespace was ignored </li> -<li> The methods operator<() and operator<<() were not +<li> The methods operator<() and operator<<() were not automatically linked anymore.</li> -<li> Some special characters in LaTeX were eating up the blanks that +<li> Some special characters in LaTeX were eating up the blanks that followed them.</li> <li> The built-in C preprocessor did not evaluate the following to TRUE: <pre> @@ -9225,31 +9395,31 @@ make sure you add the following: ... #endif </pre></li> -<li> Improved code parsing a bit: things like - <code>getClass()->func()</code> and - <code>(*pb)->func()</code> should now work. Also the scope of the - body is correctly detected in case of inline constructor initializers +<li> Improved code parsing a bit: things like + <code>getClass()->func()</code> and + <code>(*pb)->func()</code> should now work. Also the scope of the + body is correctly detected in case of inline constructor initializers like: <code>A() : m_a(10) { ... }</code></li> -<li> File index is now in (path,name) lexical order, instead of (name,path) +<li> File index is now in (path,name) lexical order, instead of (name,path) order. The file index is also only generated once instead of twice ;-)</li> -<li> Typedefs to structs in C-style did (still) not get resolved as "usage" +<li> Typedefs to structs in C-style did (still) not get resolved as "usage" relations for the collaboration diagrams.</li> <li> Fixed some HTML output typos reported by Onno Kortmann (who used the tool "html tidy" on the generated output).</li> <li> Merged a patch from Paul Lieverse that should solve the empty image map problems on Solaris.</li> -<li> If the title of a <code>\defgroup</code> contained a documented class, a +<li> If the title of a <code>\defgroup</code> contained a documented class, a nested (and thus broken) link was generated. </li> <li> Externally defined variable were treated as variable definitions. </li> <li> If a file only had a verbatim header but no documentation, a link broken link was added to the HTML help TOC.</li> -<li> Fixed "member with no name" warning that occurred when a enum's +<li> Fixed "member with no name" warning that occurred when a enum's last value ended with a comma and the enum was inside a member group.</li> -<li> A <dl> type of list with multiple <dd>'s did not give +<li> A <dl> type of list with multiple <dd>'s did not give the correct output in LaTeX.</li> -<li> <code>SORT_MEMBER_DOCS</code> is <code>NO</code> only worked for +<li> <code>SORT_MEMBER_DOCS</code> is <code>NO</code> only worked for class members.</li> -<li> Both the prototype and the definition of a global function +<li> Both the prototype and the definition of a global function appeared in a <code>\defgroup</code>.</li> <li> Fixed some visual problems with operator links in source code fragments.</li> @@ -9280,20 +9450,20 @@ make sure you add the following: <li> Added a new config option HIDE_SCOPE_NAMES that can be set to YES to hide the namespace and class scopes that are put in the documentation and diagrams.</li> -<li> added a new type of graph, that can be used to visualize - which files #include (i.e. depend on) a given file. This graph is +<li> added a new type of graph, that can be used to visualize + which files #include (i.e. depend on) a given file. This graph is enabled by setting HAVE_DOT and INCLUDED_BY_GRAPH to YES.</li> <li> added new configuration option EXTRACT_STATIC that can be used to enable/disable the extraction of static file members. The behavior of this option used to be linked with EXTRACT_PRIVATE.</li> -<li> Added two new configuration options MAX_DOT_GRAPH_WIDTH and +<li> Added two new configuration options MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT that let the user configure how big the generated dot graph may become.</li> <li> Added a new configuration option EXPAND_AS_DEFINED that can - be used in combination with PREPROCESSING = YES, MACRO_EXPANSION = YES, + be used in combination with PREPROCESSING = YES, MACRO_EXPANSION = YES, and EXPAND_PREDEF_ONLY = YES, to expand a given list of macro names, as they are defined in the sources.</li> -<li> Merged Alexander Bartolich's RTF style sheet patch. +<li> Merged Alexander Bartolich's RTF style sheet patch. A new config option RTF_STYLESHEET_FILE is now available with which you can specify a style sheet file. The style sheet file should contain a list of assignments. The assignments can be used to overwrite the @@ -9301,10 +9471,10 @@ make sure you add the following: <li> Added a new command @since for JavaDoc compatibility.</li> <li> Added two new commands: \remarks and \attention that work in a similar way as \warning, \pre, \post, et al.</li> -<li> If SOURCE_BROWSER = YES, each member function documentation - now includes a list of member functions that call the member +<li> If SOURCE_BROWSER = YES, each member function documentation + now includes a list of member functions that call the member somewhere in their body. </li> -<li> RCS/CVS tags of the form $word:text$ are now nicely typeset in the +<li> RCS/CVS tags of the form $word:text$ are now nicely typeset in the documentation.</li> <li> Providing all members of an enum with the same documentation can now be done with member grouping like this: @@ -9329,7 +9499,7 @@ make sure you add the following: int getFunc2(); //@} - /*@{ @name Set functions + /*@{ @name Set functions * Functions for setting values. */ void setFunc1(int v); @@ -9338,25 +9508,25 @@ make sure you add the following: </pre></li> <li> Merged Czech language support patches send by Petr Prikryl. Also removed some obsolete methods from the translator files.</li> -<li> Call chains like <code>a->b()->c()</code> are now followed +<li> Call chains like <code>a->b()->c()</code> are now followed by the code parser so <code>c()</code> is linked if documented. </li> </ul> <h3>Bug fixes</h3> <ul> <li> the warning message in case of ambiguous file matches was containing a bogus <code>%s</code>, which could even crash doxygen.</li> -<li> An autolist followed by a \retval, \param, or \exception did +<li> An autolist followed by a \retval, \param, or \exception did produced invalid output, resulting in a compile error in LaTeX. </li> <li> " has a special meaning in LaTeX when the german babel package is loaded. Doxygen now produces proper output for text containing quotes.</li> <li> The title of a related page was not properly parsed, causing - HTML special characters to end up in the output for some languages + HTML special characters to end up in the output for some languages (German for instance). </li> <li> The hierarchy shown in the "Contents" part of the html help browser did not properly show the hierarchy when it contained undocumented classes. </li> -<li> explicit compound specifiers in the return type could lead to +<li> explicit compound specifiers in the return type could lead to parse problems. Example: <pre> enum SomeEnumType_e Func() @@ -9371,13 +9541,13 @@ make sure you add the following: and links to the correct reimplemented member are generated.</li> <li> \ingroup did not work when grouping enums</li> <li> members of a module were not cross-referenced with the sources.</li> -<li> Function pointers like <code>void ( *func )()</code> where not - correctly parsed because of the extra spacing between +<li> Function pointers like <code>void ( *func )()</code> where not + correctly parsed because of the extra spacing between the `(' and the `*'. </li> <li> The const in void <code>func(int * const val /*< a value. */);</code> was named part of the name, instead of the type.</li> <li> Removed bogus warning in case of global function pointer variables. - Function pointers inside namespaces and member function pointers + Function pointers inside namespaces and member function pointers did also produce bogus warnings.</li> <li> Fixed a misalignment problem with inline source fragments. Also the initializer list after a colon is now included in an inline @@ -9398,42 +9568,42 @@ make sure you add the following: This was already possible for functions.</li> <li> Due to a bracket counting bug, throw clauses where not always parsed properly.</li> -<li> Fixed a parse bug for the following code-pattern: +<li> Fixed a parse bug for the following code-pattern: <pre> void Class:: // Comment method() {} </pre></li> -<li> With the newer Qt versions (2.1.x), passing a null string as the first - argument of <code>QRegExp::match</code> seems no longer be allowed, +<li> With the newer Qt versions (2.1.x), passing a null string as the first + argument of <code>QRegExp::match</code> seems no longer be allowed, so I added some extra checks to avoid potential crashes.</li> <li> The title of the documentation of a template class now explicitly states that it is a template. (For non-English languages, - this still requires a change to trCompoundReference() in + this still requires a change to trCompoundReference() in translator_xx.h).</li> <li> Fixed a problem with matching methods of template classes.</li> -<li> commenting out a section or subsection with <code><!-- --></code> +<li> commenting out a section or subsection with <code><!-- --></code> did not work.</li> -<li> Fixed some inconsistencies in the configuration page of +<li> Fixed some inconsistencies in the configuration page of the documentation.</li> -<li> Some operators like <code>operator[]()</code>, +<li> Some operators like <code>operator[]()</code>, <code>operator|()</code> and <code>operator!()</code> did not appear correctly in the LaTeX index.</li> <li> If an include file name matched a directory name, then the - directory could be found first in the INCLUDE_PATH. This resulted in a + directory could be found first in the INCLUDE_PATH. This resulted in a scanner error.</li> -<li> Fixed parse problems that occurred when << or >> was +<li> Fixed parse problems that occurred when << or >> was part of a template argument list.</li> <li> Fixed some more parse problems that occurred when parsing base classes that were nested templates.</li> -<li> variables whose name started - with an _ like <code>struct {int x; } _var;</code> +<li> variables whose name started + with an _ like <code>struct {int x; } _var;</code> where not properly parsed.</li> -<li> LaTeX formulas did not work in the brief description of a JavaDoc +<li> LaTeX formulas did not work in the brief description of a JavaDoc style block that was put after an item.</li> <li> Empty group definitions were not properly handled.</li> <li> References to pages using \ref did not work in LaTeX.</li> -<li> Members that are typedef's to classes are now shown in the +<li> Members that are typedef's to classes are now shown in the collaboration diagram.</li> </ul> @@ -9442,16 +9612,16 @@ make sure you add the following: <h3>Changes</h3> <ul> -<li> The member definition that is put before the detailed +<li> The member definition that is put before the detailed documentation section should now be layouted a bit better for members of classes with lots of template arguments.</li> <li> The HTML pages now have a new doxygen logo at the bottom. This logo has - a transparent background and no shadow or anti-aliasing, so it looks + a transparent background and no shadow or anti-aliasing, so it looks equally nice on all backgrounds.</li> <li> If the first member of a member group is documented, this documentation is now repeated for all undocumented members of that group. </li> <li> The following is now treated as one parameter list with two - parameters, instead of two lists with one parameter each. + parameters, instead of two lists with one parameter each. <pre> /*! * @param a the first parameter @@ -9490,17 +9660,17 @@ make sure you add the following: void Member3(); }; </pre></li> -<li> Added three new configuration options: +<li> Added three new configuration options: <ul> <li>WARN_IF_UNDOCUMENTED which can be used to turn on or off warning message related to undocumented entities. This works independently - of the WARNING tag, which is there to enable/disable all + of the WARNING tag, which is there to enable/disable all other warning messages.</li> <li>WARN_FORMAT which can be used to specify the format of the warnings produced by doxygen. The argument is a free form string - that must contain a $file, $line and $text marker. - The $file and $line markers will be replaced by the file name and line - number from where the warning originated. + that must contain a $file, $line and $text marker. + The $file and $line markers will be replaced by the file name and line + number from where the warning originated. The $text marker will be replaced by the actual warning text. The default argument format string is: <code>"$file:$line: $text"</code>.</li> <li>DOT_PATH that can be used to specify the path @@ -9529,17 +9699,17 @@ make sure you add the following: Using of individual functions remains unsupported.</li> <li> collaboration and include dependency graph are now also included in the LaTeX documentation.</li> -<li> Thanks to Tim Mensch, doxygen has now has a \todo command, which - can be used put todo items in the documentation. - All items will automatically be cross-referenced with a +<li> Thanks to Tim Mensch, doxygen has now has a \todo command, which + can be used put todo items in the documentation. + All items will automatically be cross-referenced with a (generated) todo list. Here is an example: <pre> - /*! \mainpage + /*! \mainpage * \todo write something useful here. */ /*! A class - * \todo Add more comments here + * \todo Add more comments here */ class Test { @@ -9564,10 +9734,10 @@ make sure you add the following: /*! A macro */ #define AMACRO 11 - //@{ + //@{ /*! F1 macros */ - #define F1_0 0 - #define F1_1 (F1_0 + 1) + #define F1_0 0 + #define F1_1 (F1_0 + 1) #define F1_2 (F1_1 + 2) //@} @@ -9578,11 +9748,11 @@ make sure you add the following: member attributes instead of return types.</li> <li> the index page is now added to the HTML help contents.</li> <li> In case "no matching member" is found, a list of possible - (but non-matching) candidates is generated along with the warning. + (but non-matching) candidates is generated along with the warning. This makes it much easier to see what's wrong. </li> -<li> added two new commands: +<li> added two new commands: <ul> - <li>\hideinitializer which can be put in the documentation to + <li>\hideinitializer which can be put in the documentation to a variable or the define to hide the initializer or define value.</li> <li>\showinitializer which can be used to explicitly show the initializer of a variable or the value of a define even if it @@ -9591,7 +9761,7 @@ make sure you add the following: </ul> <h3>Bug fixes</h3> <ul> -<li> Fixed a lock-up problem, that occurred when +<li> Fixed a lock-up problem, that occurred when parsing a code fragment containing something like: <pre> // @@ -9600,25 +9770,25 @@ make sure you add the following: */ </pre> while STRIP_CODE_COMMENTS was set to NO </li> -<li> The auto list feature was still broken. - Due to a bad scanner rule, things like -1 at the start of a line - were treated as a list items (again) and a list at the end of a +<li> The auto list feature was still broken. + Due to a bad scanner rule, things like -1 at the start of a line + were treated as a list items (again) and a list at the end of a comment block did not always work either.</li> <li> If an non-existent config file was specified, the directories "html", "man" and "latex" were created anyway.</li> -<li> A fragment like: os <code><< ">"</code> was misinterpreted +<li> A fragment like: os <code><< ">"</code> was misinterpreted by doxygen's code parser.</li> <li> Parameter declarations that differ only in the presence or absence of const and/or volatile are now treated as equivalent, as is dictated by the C++ standard.</li> <li> The inline function body was wrong in the following example: <pre> - void f( - int i ///< Parameter - ) - { - return 1; - } + void f( + int i ///< Parameter + ) + { + return 1; + } </pre> Thanks to Alexander Gidon for the fix.</li> <li> typedef'ed classes are now also resolved in code fragments @@ -9634,22 +9804,22 @@ make sure you add the following: <li> #includes in code fragments where not hyperlinked. Operator methods were also not correctly recognized.</li> <li> C/C++ comments inside initializers where not handled properly.</li> -<li> If the type of an argument of a member definition was prefixed - with a (redundant) scope name of an indirect base class, +<li> If the type of an argument of a member definition was prefixed + with a (redundant) scope name of an indirect base class, then it was not matched against the member declaration if that omitted the scope.</li> <li> \name did not work within //! comments</li> <li> When FULL_PATH_NAMES was set to YES, doxygen did no longer - distinguish between files with the same name (but in + distinguish between files with the same name (but in different directories). </li> <li> The file match routine now does an case-insensitive lookup - if CASE_SENSE_NAMES = NO. Hopefully this is enough to + if CASE_SENSE_NAMES = NO. Hopefully this is enough to let doxygen ignore case differences in file names on Windows.</li> <li> The constructors and destructors of classes inside namespaces or other classes did not end up in the constructor/destructor section of the documentation.</li> -<li> If an environment variable in the config file starts with a space - followed by a list of words, the space ends up in the first word +<li> If an environment variable in the config file starts with a space + followed by a list of words, the space ends up in the first word after expansion.</li> <li> A <table> inside a JavaDoc style comment block caused a bogus warning.</li> @@ -9657,7 +9827,7 @@ make sure you add the following: LaTeX, causing a error while compiling the documentation.</li> <li> Fixed a missing stdlib.h problem in doxywizard, which occurred on non-Linux systems.</li> -<li> The generation of dot include graphs did not work properly in +<li> The generation of dot include graphs did not work properly in case file names with space were used.</li> <li> back-references from source-lines to documentation only worked for those members of a member group that were explicitly documented.</li> @@ -9675,9 +9845,9 @@ make sure you add the following: <li> Changed the way anonymous enums are handled: they are now handled just like named enums, which makes the "Enumeration Values" section obsolete.</li> -<li> If +<li> If <pre> - /*! \file */ + /*! \file */ </pre> is put into a file (thus without further documentation) then the file is treated as being documented.</li> @@ -9691,16 +9861,16 @@ make sure you add the following: </pre> The front-end requires Qt 2.x to build. I've only tested with Qt-2.1. Sources can be found in the addon directory.</li> -<li> To make it very easy to add new configuration options, doxygen +<li> To make it very easy to add new configuration options, doxygen now has an additional tool called configgen. All options supported by doxygen are now located in one place (in configgen.cpp). - From this the configuration parser and part of the GUI are + From this the configuration parser and part of the GUI are generated. You only need configgen if you want to add new options to doxygen. Thanks go to Joerg Baumann for providing the ideas and part of the code.</li> <li> Added a bit of syntax highlighting to the generated source - fragments in HTML (only keywords, comments and preprocessor directives - are colored for now). The font color & style is determined by + fragments in HTML (only keywords, comments and preprocessor directives + are colored for now). The font color & style is determined by the style sheet, so it is easy to customize :-)</li> <li> Typedefs of classes are now resolved when the inheritance and usage relation of classes is determined.</li> @@ -9708,14 +9878,14 @@ make sure you add the following: <ol> <li>Now it uses the translator for the table of contents entry names for the sections.</li> - <li>writeSection now puts braces around the entry so the formatting + <li>writeSection now puts braces around the entry so the formatting doesn't get messed up so easily. </li> <li>removed extra newline in startDescList </li> <li>writeSectionRef now writes out "title (p.pagnum)" like it should.</li> <li>writeSectionRefAnchor now just calls writeSectionRef. </li> </ol></li> -<li> Doxygen's preprocessor now supports the non-ANSI "#else if" - preprocessor construction, which some other preprocessors seem to +<li> Doxygen's preprocessor now supports the non-ANSI "#else if" + preprocessor construction, which some other preprocessors seem to accept as well.</li> <li> Boris Bralo added language support for the Croatian language. Nickolay Semyonov has finished the translation to Russian, which is @@ -9742,7 +9912,7 @@ make sure you add the following: <li> <code>\c func()</code> did not autolink to function "func" anymore. </li> <li> template members with multiple arguments were misaligned in the HTML output. </li> -<li> Since 1.1.2, environment variable expansion in the config +<li> Since 1.1.2, environment variable expansion in the config file always resulted in a single string for each expanded variable (just as if quotes were put around the environment variable). The old behavior is restored again.</li> @@ -9753,22 +9923,22 @@ make sure you add the following: <li> fixed a problem in the namespace strip routine that could potentially lock up doxygen.</li> <li> Long pre-initialized arrays ended up in the documentation.</li> -<li> Friend functions that were documented at the declaration were +<li> Friend functions that were documented at the declaration were cross-referenced to the wrong file when using SOURCE_BROWSER=YES.</li> -<li> When EXTRACT_ALL=YES was used, classes that were +<li> When EXTRACT_ALL=YES was used, classes that were documented with \class appeared twice in the namespace documentation.</li> <li> Setting HIDE_UNDOC_CLASS=YES could result in an incorrectly indented textual class hierarchy. This should now be fixed.</li> <li> Members with very long return types caused all member names to - be pushed to the right in the HTML documentation + be pushed to the right in the HTML documentation (if HTML_ALIGN_MEMBERS was YES). Now some line breaks are inserted at the proper places.</li> -<li> A couple of people reported that doxygen crashed while it was generating - dot graphs. The cause was likely to be multiple frees of the same - pointer (but I have not been able to reproduce the crash myself). +<li> A couple of people reported that doxygen crashed while it was generating + dot graphs. The cause was likely to be multiple frees of the same + pointer (but I have not been able to reproduce the crash myself). I've now reimplemented the deletion routine of the dot graph representation, which hopefully fixes this problem.</li> -<li> Elements of the configuration options in lists, which used quotes +<li> Elements of the configuration options in lists, which used quotes were broken up into smaller pieces anyway. This most notably broke PREDEFINED in some cases that worked before.</li> <li> Detailed description was present for classes, files and namespaces @@ -9780,24 +9950,24 @@ make sure you add the following: following situation: <pre> template <class T> class A { public: class inner { }; }; - template <class T> class B : public A<T> - { public: class inner : public A<T>::inner { }; }; + template <class T> class B : public A<T> + { public: class inner : public A<T>::inner { }; }; </pre> </li> -<li> Fixed a bug that prevented the header links of the search engine +<li> Fixed a bug that prevented the header links of the search engine from working.</li> <li> Undocumented classes & enums made it in the file documentation even if HIDE_UNDOC_MEMBERS was set to YES.</li> <li> Backslashes in includes like <pre> - #include "..\blah.h" + #include "..\blah.h" </pre> did not end up in the include dependency graph.</li> <li> If ALPHABETICAL_INDEX=YES but there were no documented classes, part - of the LaTeX output (doxygen.sty a.o.) was not generated + of the LaTeX output (doxygen.sty a.o.) was not generated (Thanks to Markus Lepper for reporting this).</li> <li> Doxygen can now match arguments containing an explicit namespace - qualifier against arguments containing an implicit qualifier - (i.e. imported via a using directive). + qualifier against arguments containing an implicit qualifier + (i.e. imported via a using directive). An example (thanks to Karl Stroetmann): <pre> /*! a class */ @@ -9805,10 +9975,10 @@ make sure you add the following: { public: void resolve(const std::vector<int>&); - }; - using namespace std; + }; + using namespace std; /*! a member */ - void Test::resolve(const vector<int>&) {} + void Test::resolve(const vector<int>&) {} </pre> </li> <li> Template specifiers are now shown in dot generated collaboration graphs.</li> @@ -9854,17 +10024,17 @@ make sure you add the following: */ </pre></li> <li> Again thanks to Joerg Baumann, URLs and mail addresses are now - hyperlinked in the PDF output + hyperlinked in the PDF output (=latex with <code>PDF_HYPERLINKS = YES</code>).</li> <li> Added support for member grouping. I reimplemented this - from scratch. I decided to follow the doc++ syntax for the member - grouping. Here are two examples. + from scratch. I decided to follow the doc++ syntax for the member + grouping. Here are two examples. <p> - <b>Usage:</b> A group is defined by a <code>//@{ .. //@}</code> block - (or <code>/*@{*/../*@}*/</code> if - you're addicted to C style comments :-) Nesting of groups is not - allowed. Before the opening marker of a block a separate comment - block should be placed. This block should contain the @name + <b>Usage:</b> A group is defined by a <code>//@{ .. //@}</code> block + (or <code>/*@{*/../*@}*/</code> if + you're addicted to C style comments :-) Nesting of groups is not + allowed. Before the opening marker of a block a separate comment + block should be placed. This block should contain the @name (or \name) command to specify the header of the group. </p> <p> @@ -9911,7 +10081,7 @@ make sure you add the following: <b>Example2:</b> Combining member groups with @defgroup. </p> <pre> - /** @defgroup globals Global Functions + /** @defgroup globals Global Functions * Functions that may be used in any translation unit. */ @@ -9956,38 +10126,38 @@ make sure you add the following: included. Jens Breitenstein sent an update for the German translation. Philippe Lhoste sent some bug fixes for the French translation. Alessandro Falappa sent an updated of the Italian translation, which - is now included. Nickolay Semyonov added initial support for the + is now included. Nickolay Semyonov added initial support for the Russian language. I updated the Dutch translation.</li> -<li> Thanks to Matthias Andree, the doxygen source package - now contains a .spec file. This can be used to build an .rpm package +<li> Thanks to Matthias Andree, the doxygen source package + now contains a .spec file. This can be used to build an .rpm package for doxygen. doing: <pre> rpm -ta doxygen-x.y.z.src.tar.gz </pre> will create the rpm (in /usr/src/packages/RPMS/i386/ on my machine). - Running <code>rpm -Uhv</code> as root on the .rpm file will - install/update doxygen. + Running <code>rpm -Uhv</code> as root on the .rpm file will + install/update doxygen. After that you can use <code>rpm -e doxygen</code> to uninstall it again.</li> -<li> Umlauts and other accents in the documentation now appear properly in +<li> Umlauts and other accents in the documentation now appear properly in generated RTF output. </li> </ul> <h3>Bug fixes</h3> <ul> <li> Fixed bug in the generated config file (LATEX_BATCHMODE)</li> -<li> When updating the config file, <code>TAB_SIZE</code> and +<li> When updating the config file, <code>TAB_SIZE</code> and <code>COLS_IN_ALPHA_INDEX</code> - were reset to their default values. Environment variables in - the config file are no longer replaced by their value when updating + were reset to their default values. Environment variables in + the config file are no longer replaced by their value when updating the config file. </li> <li> The version.cpp file is now automatically updated when creating a source/cvs package.</li> -<li> The types of arguments that are prefixed with a namespace scope +<li> The types of arguments that are prefixed with a namespace scope are now be matched against non-prefixed names. Example: <pre> namespace std { class string {}; } //! A class - class Test { + class Test { public: void test(std::string a); }; @@ -9995,12 +10165,12 @@ make sure you add the following: //! A member void Test::test(string a); </pre> - <b>Note:</b> The namespace definition has to be part of the + <b>Note:</b> The namespace definition has to be part of the input sources for this to work!</li> <li> Fixed a bug in structure of the graphical class hierarchy (thanks to Paul Bohme for pointing me at this bug)</li> <li> Non-function members can now also be documented if they - are inside anonymous namespaces, which themselves are nested in + are inside anonymous namespaces, which themselves are nested in named namespaces.</li> <li> #defines can now grouped with \defgroup and \ingroup as well.</li> <li> fixed a bug in the latex output of groups (thanks to Gregory Kurz @@ -10015,16 +10185,16 @@ make sure you add the following: class Test {}; </pre> Doxygen now ends the brief description when a <table> tag is encountered.</li> -<li> \c and \b now also accept numbers and other printable characters, +<li> \c and \b now also accept numbers and other printable characters, instead of only identifiers.</li> <li> Autolinking did not work if a member with arguments was specified in the documentation and that member had a const or volatile postfix - in the code. Autolinking did not also not work if a member with + in the code. Autolinking did not also not work if a member with arguments contained digits (thanks to Fred Labrosse for pointing me at this bug).</li> <li> The first line was missed if @code was used for generating man pages. (Thanks to Joe Bester for the patch). </li> -<li> <code>\link create_link(long,int&) bla \endlink</code> +<li> <code>\link create_link(long,int&) bla \endlink</code> now works (doxygen was confused by the arguments before).</li> <li> A brief description after a function definition, followed by a detailed description now works as expected. Example: @@ -10042,20 +10212,20 @@ make sure you add the following: //!< Brief. //!< More brief. </pre></li> -<li> \latexonly fragments were put on a single line causing problems +<li> \latexonly fragments were put on a single line causing problems when latex comments (%'s) are used. </li> <li> The license file that came with doxygen was of LGPL, while it should be GPL. The correct license file is included now.</li> -<li> The heading of the alphabetical index was duplicated if +<li> The heading of the alphabetical index was duplicated if classes were present in both upper and lower case.</li> <li> If ENABLE_PREPROCESSING=NO and the INPUT_FILTER was used, doxygen did not filter properly can could even block on input!</li> <li> Internationalization should now output proper characters with qt-2.1x.</li> <li> If namespace contained a function prototype & a function definition they both ended up in the documentation.</li> -<li> <table> without </table> could cause doxygen to crash. Now a +<li> <table> without </table> could cause doxygen to crash. Now a warning is given.</li> -<li> Multiline variable and enum initializers with lots of spaces were +<li> Multiline variable and enum initializers with lots of spaces were shown in an ugly way.</li> </ul> @@ -10066,9 +10236,9 @@ make sure you add the following: <h3>Changes</h3> <ul> <li> "Reimplements" for a member now points to the most direct - base class that overrides the member instead of the base + base class that overrides the member instead of the base class containing the vtable.</li> -<li> classes, namespaces, and members are now sorted +<li> classes, namespaces, and members are now sorted in a case insensitive way (like in a dictionary). Was case sensitive.</li> <li> Kenji Nagamatsu has send me an update for the Japanese translation @@ -10084,53 +10254,53 @@ make sure you add the following: is set to NO the member documentation will appear in declaration order (as was the case with version 1.0.0 and older). </li> <li> Corba IDL exceptions are now also supported by doxygen. - If you do not want to put the documentation in front of the + If you do not want to put the documentation in front of the exception you can use \idlexcept command which behaves like \class.</li> <li> Local file:/// URLs are now automatically linked when put in the documentation.</li> -<li> For \class and other structural commands you can now use - a backslash (\) at the end of a line to continue the command on - the next line. +<li> For \class and other structural commands you can now use + a backslash (\) at the end of a line to continue the command on + the next line. Example: <pre> \class Abstract_Server_Session_Implementation \ Abstract_Server_Session_Implementation.h \ - ATD/Abstract_Server_Session_Implementation.h + ATD/Abstract_Server_Session_Implementation.h </pre></li> <li> "make distclean" now removes all generated stuff and results in a - package that is more clean than a normal source package + package that is more clean than a normal source package (i.e. the generated flex & bison code is removed). </li> <li> Added command \note (and @note) for a "Note:" paragraph.</li> -<li> Multi arguments can now be given as a comma separated list +<li> Multi arguments can now be given as a comma separated list after a \param or \retval command. Example: <pre> - void Zoom( int aX1, int aY1, int aX2, int aY2 ); - /*! Zoom into the data. - * \param aX1, aY1 Upper left corner. - * \param aX2, aY2 Lower right corner. + void Zoom( int aX1, int aY1, int aX2, int aY2 ); + /*! Zoom into the data. + * \param aX1, aY1 Upper left corner. + * \param aX2, aY2 Lower right corner. */ </pre></li> -<li> Added 9 new class declaration sections: +<li> Added 9 new class declaration sections: Public/Protected/Private Types, for member typedefs & variables. [Static] Public/Protected/Private Attributes, for member variables.</li> <li> Doxygen now has a new command line option -u, that can be used - to upgrade an old configuration file without losing the values that + to upgrade an old configuration file without losing the values that where edited. In combination with the -s option this can also be used to strip comments from or add comments to a configuration file.</li> <li> Added a new tag LATEX_BATCHMODE that makes latex run in batch mode. This will run latex non-interactively, and not stop at the first - problem encountered. If the tag is enabled this mode will also be + problem encountered. If the tag is enabled this mode will also be used when generation formulas for inclusion in the HTML documentation.</li> <li> The \ingroup command can now also be used to group a number of members. The only limitation is that a member can currently be in - one group only (classes, files & namespaces do + one group only (classes, files & namespaces do not have this limitation). </li> </ul> <h3>Bug fixes</h3> <ul> <li> The graphical class hierarchy was not properly generated when template classes were used.</li> -<li> Template specialization could not be documented using the +<li> Template specialization could not be documented using the \class command. This is now fixed. Example: <pre> /*! @@ -10138,17 +10308,17 @@ make sure you add the following: * My template specialization of template T. */ </pre></li> -<li> Fixed a bug when parsing M$-IDL code, containing +<li> Fixed a bug when parsing M$-IDL code, containing helpstring("bla") attributes. The attributes of a method are no longer - shown in the documentation (the attributes of method arguments + shown in the documentation (the attributes of method arguments still visible however).</li> <li> Improved the search algorithm that tries to connect classes with their - base classes. It should now (hopefully) work correct in all cases + base classes. It should now (hopefully) work correct in all cases where nested classes and/or namespaces are used. </li> <li> Fixed a scanner problem that could cause doxygen to get confused after parsing struct initializers.</li> <li> the DOTFONTPATH environment variable is now automatically set - for Windows. This should make any "missing doxfont.ttf" + for Windows. This should make any "missing doxfont.ttf" messages disappear.</li> <li> the extra LaTeX packages specified with EXTRA_PACKAGES can now also be used when generating formulas for HTML. </li> @@ -10157,14 +10327,14 @@ make sure you add the following: <li> Fixed a HTML output bug in the class/file group-pages.</li> <li> Links to example files generated with \link ... \endlink where not correct. </li> -<li> made the bullet list generation more robust. A space is now required +<li> made the bullet list generation more robust. A space is now required after the - sign. A list can now start a paragraph.</li> <li> the configure script now detects whether or not dot is installed.</li> <li> The VERBATIM_HEADERS option didn't have any effect any more. It should now work again as advertised.</li> <li> The IGNORE_PREFIX option can now also deal with a list of prefixes.</li> <li> @verbatim ... @endverbatim blocks did not work. </li> -<li> removed some \n's from the systems calls that run dot. This appears to +<li> removed some \n's from the systems calls that run dot. This appears to cause problems for some people and was not what I intended anyway :^)</li> <li> The following construct was not working: <pre> @@ -10172,14 +10342,14 @@ make sure you add the following: /*! let's go to the bar */ class foo::bar { }; </pre></li> -<li> Members inside anonymous namespaces nested inside named namespaces +<li> Members inside anonymous namespaces nested inside named namespaces were not properly handled. </li> <li> When documenting template specializations with the \class command, the second argument was not interpreted correctly.</li> -<li> Interface inheritance relations are now always public for IDL +<li> Interface inheritance relations are now always public for IDL interfaces.</li> <li> Templetized related functions showed a double `template' line.</li> -<li> Related function that had a declaration and a definition +<li> Related function that had a declaration and a definition also appeared in file documentation but without documentation. </li> <li> Links to files of the include dependency graph were non existent in some situations.</li> @@ -10189,7 +10359,7 @@ make sure you add the following: <li> The graphical class hierarchy always contained all external class, regardless of the ALLEXTERNALS flag.</li> <li> operator~() was grouped with the constructor/destructors.</li> -<li> In a number of cases, documented include files, that were +<li> In a number of cases, documented include files, that were shown in the include dependency diagram where not found to be documented. As a result the diagram was often not clickable and incomplete.</li> @@ -10214,8 +10384,8 @@ make sure you add the following: <pre> /** \union XYZ * \brief The XYZ union. - */ - union XYZ switch ( ABC ) + */ + union XYZ switch ( ABC ) { case A: D_VAR m_d; ///< Docs for a member in case A case B: E_VAR m_e; ///< Docs for a member in case B @@ -10242,22 +10412,22 @@ make sure you add the following: <h3>New features</h3> <ul> -<li> Thanks to Parker Waechter, doxygen now has a new output format: RTF. - This is Microsoft's "portable" document format. Due to the great - "portability" of this format the output produced by doxygen will +<li> Thanks to Parker Waechter, doxygen now has a new output format: RTF. + This is Microsoft's "portable" document format. Due to the great + "portability" of this format the output produced by doxygen will probably only look nice with Microsoft's Word 97. <p> - RTF is currently disabled by default. You can set GENERATE_RTF to + RTF is currently disabled by default. You can set GENERATE_RTF to YES to enable it. The directory where the RTF output is put, can be specified using the RTF_OUTPUT tag in the configuration file. COMPACT_RTF can be enabled to generate more compact RTF. RTF_HYPERLINKS can be used to generate HTML like cross references in the document. </p></li> -<li> Doxygen can now use the "dot" tool from graphviz 1.5, which is an - open-sourced, cross-platform graph drawing toolkit from AT&T and +<li> Doxygen can now use the "dot" tool from graphviz 1.5, which is an + open-sourced, cross-platform graph drawing toolkit from AT&T and Lucent Bell Labs. <p> - Graphviz can be found at + Graphviz can be found at <a href="https://www.graphviz.org/">https://www.graphviz.org/</a> If you have the "dot" tool available in the path, you can set HAVE_DOT to YES in the configuration file to let doxygen use it. @@ -10266,7 +10436,7 @@ make sure you add the following: </p> <ul> <li>if GRAPHICAL_HIERARCHY is set to YES, a graphical representation - of the overall inheritance diagram will be drawn, + of the overall inheritance diagram will be drawn, along with the textual one (currently supported for HTML only).</li> <li>if INCLUDE_GRAPH is set to YES, an include dependency graph is generated for each documented file that includes at least one @@ -10274,29 +10444,29 @@ make sure you add the following: <li>if COLLABORATION_GRAPH is set to YES, a graph is drawn for each documented class and struct that shows: <ul> - <li> the inheritance relation with base classes + <li> the inheritance relation with base classes (using solid blue/green/red arrows, for public,protected,private inheritance).</li> - <li> the containment relations with other structs + <li> the containment relations with other structs and class (using purple dashed arrows with variable names as labels) (currently supported for HTML and RTF only)</li> </ul></li> </ul> <p> - For the include dependency graph and the collaboration graph, + For the include dependency graph and the collaboration graph, doxygen will render a transitive closure of the relation. If the diagram becomes too large (currently wider than 1024 pixels), - only the maximum graph depth (as seen from the root of the - graph) that still fits will be drawn. (the nodes that can still be + only the maximum graph depth (as seen from the root of the + graph) that still fits will be drawn. (the nodes that can still be expanded are shown with a red border in this case). </p><p> For HTML all graphs are drawn as client side clickable image maps.</p></li> -<li> Each file now has a list the files it includes +<li> Each file now has a list the files it includes (with links to the sources if available)</li> <li> For class documentation it is now possible to choose how the - <code>#include</code> statement should look like - (i.e. like "stdio.h" or <stdio.h>). - This can be done using the third argument of + <code>#include</code> statement should look like + (i.e. like "stdio.h" or <stdio.h>). + This can be done using the third argument of the <code>\class</code> command. Example: <pre>\class myclass myclass.h "mydir/myclass.h"</pre></li> <li> If the - character is used as the first character in a comment line @@ -10318,23 +10488,23 @@ make sure you add the following: */ </pre> - Notice: tabs can be used for indenting, but the TAB_SIZE tag in the + Notice: tabs can be used for indenting, but the TAB_SIZE tag in the configuration file must be set correctly!</li> <li> Function/member arguments can now be documented, like this <pre> - /*! This function finds the first occurrence of a - * substring in a string. + /*! This function finds the first occurrence of a + * substring in a string. */ char *strstr(const char *haystack, /*!< the string to search in. */ - const char *needle) /*!< the substring to search for. */ + const char *needle) /*!< the substring to search for. */ { } </pre></li> -<li> Three new section commands <code>\pre</code>, <code>\post</code> and +<li> Three new section commands <code>\pre</code>, <code>\post</code> and <code>\invariant</code> are added to describe preconditions, postconditions and invariants respectively.</li> -<li> Variable/enum initializers and define definitions are - now included in documentation (unless the initializer/definition +<li> Variable/enum initializers and define definitions are + now included in documentation (unless the initializer/definition is more than 30 lines long)</li> <li> Added new configuration option IGNORE_PREFIX that can be used to ignore a specified prefix while generating the alphabetical @@ -10345,7 +10515,7 @@ make sure you add the following: <ul> <li> All defines were shown as function macros in the documentation section.</li> <li> Fixed bug with parsing multi-line defines on Windows (\r problem). </li> -<li> Protection level of members inside nested anonymous compounds was not +<li> Protection level of members inside nested anonymous compounds was not set correctly.</li> <li> Class diagram was not correct in case the same class was inherited via two different paths (bug introduced in 1.0.0).</li> @@ -10357,15 +10527,15 @@ make sure you add the following: <li> Members that were hidden deep in an inheritance tree, got multiple scope prefixes in the "all members list", while a scope prefix to the member in the base class was enough to use it unambiguously.</li> -<li> <code>\latexonly ... \endlatexonly</code> in the main page produced +<li> <code>\latexonly ... \endlatexonly</code> in the main page produced erroneous text in refman.tex</li> <li> The keywords in header and footer were only evaluated once.</li> <li> Formulas now also work in documentation blocks that are put after an item.</li> <li> The source code could produce links to the wrong class for - a code fragment like <code>a.f()</code> in + a code fragment like <code>a.f()</code> in case two classes have the same member variable `a', but with a - different class types and those classes both had the member + different class types and those classes both had the member function `f'.</li> <li> array type arguments (like int a[2]) where not matched if the argument name of declaration and definition were different. </li> diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt index 9b452a4..b7d4af2 100644 --- a/src/CMakeLists.txt +++ b/src/CMakeLists.txt @@ -290,6 +290,7 @@ add_library(_doxygen STATIC add_executable(doxygen main.cpp) + if (use_libclang) find_package(LLVM REQUIRED CONFIG) find_package(Clang REQUIRED CONFIG) @@ -324,9 +325,12 @@ target_link_libraries(doxygen ${CMAKE_THREAD_LIBS_INIT} ${EXTRA_LIBS} ${CLANG_LIBS} + ${DOXYGEN_EXTRA_LINK_OPTIONS} ) + set_project_warnings(doxycfg) set_project_warnings(_doxygen) set_project_warnings(doxygen) install(TARGETS doxygen DESTINATION bin) + |