diff options
Diffstat (limited to 'doc')
38 files changed, 456 insertions, 716 deletions
diff --git a/doc/.gitignore b/doc/.gitignore index a464770..d1d1371 100644 --- a/doc/.gitignore +++ b/doc/.gitignore @@ -1 +1,2 @@ -mailto.txt
\ No newline at end of file +*.bak +mailto.txt diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt new file mode 100644 index 0000000..af557d8 --- /dev/null +++ b/doc/CMakeLists.txt @@ -0,0 +1,104 @@ +if (build_doc) + +find_program(EPSTOPDF NAMES epstopdf ) +find_program(SED NAMES sed ) +find_program(MAKE NAMES make gmake nmake ) + +file(GLOB DOC_FILES "*") +file(GLOB LANG_FILES "${CMAKE_SOURCE_DIR}/src/translator_??.h") + +file(MAKE_DIRECTORY ${PROJECT_BINARY_DIR}/man) +file(MAKE_DIRECTORY ${PROJECT_BINARY_DIR}/src) +file(COPY ${CMAKE_SOURCE_DIR}/src/translator.h DESTINATION ${PROJECT_BINARY_DIR}/src) +file(COPY ${CMAKE_SOURCE_DIR}/src/translator_adapter.h DESTINATION ${PROJECT_BINARY_DIR}/src) +file(COPY ${LANG_FILES} DESTINATION ${PROJECT_BINARY_DIR}/src) +file(COPY ${CMAKE_SOURCE_DIR}/VERSION DESTINATION ${PROJECT_BINARY_DIR}) + +# copy all doc files +add_custom_target(copy_docs) +foreach(doc_file ${DOC_FILES}) + add_custom_command(TARGET copy_docs PRE_BUILD + COMMAND ${CMAKE_COMMAND} -E + copy ${doc_file} ${DOXYDOCS}) +endforeach() + +add_custom_target(docs + COMMENT "Generating documentation in ${DOXYDOCS}" + COMMAND ${EXECUTABLE_OUTPUT_PATH}/doxygen + COMMAND ${CMAKE_COMMAND} -E remove_directory ../latex/refman.tex + COMMAND ${CMAKE_COMMAND} -E copy doxygen_logo.gif ../html + COMMAND ${CMAKE_COMMAND} -E copy doxygen_logo_low.gif ../html + COMMAND ${CMAKE_COMMAND} -E copy Makefile.latex ../latex/Makefile + COMMAND ${SED} -e "s/\$VERSION/${VERSION}/g" doxygen_manual.tex > ../latex/doxygen_manual.tex + COMMAND ${SED} -e "s/\$VERSION/${VERSION}/g" doxygen.sty > ../latex/doxygen.sty + COMMAND ${EPSTOPDF} doxygen_logo.eps --outfile=../latex/doxygen_logo.pdf + COMMAND ${MAKE} -C ../latex > latex_out.txt + DEPENDS doxygen copy_docs ${PROJECT_BINARY_DIR}/doc/language.doc config.doc examples + "${PROJECT_BINARY_DIR}/man/doxygen.1" + "${PROJECT_BINARY_DIR}/man/doxywizard.1" + "${PROJECT_BINARY_DIR}/man/doxysearch.1" + "${PROJECT_BINARY_DIR}/man/doxyindexer.1" + WORKING_DIRECTORY ${DOXYDOCS} + VERBATIM + ) + +# language.doc +add_custom_command( + COMMAND ${CMAKE_COMMAND} "-DSOURCE=${CMAKE_SOURCE_DIR}" -P ${CMAKE_SOURCE_DIR}/cmake/run_translator.cmake + DEPENDS ${DOXYDOCS}/translator.py + DEPENDS maintainers.txt language.tpl translator.py + OUTPUT ${PROJECT_BINARY_DIR}/doc/language.doc + WORKING_DIRECTORY ${DOXYDOCS} +) +set_source_files_properties(${DOXYDOCS}/language.doc PROPERTIES GENERATED 1) + +# config.doc +add_custom_command( + COMMAND ${PYTHON_EXECUTABLE} ${CMAKE_SOURCE_DIR}/src/configgen.py -doc ${CMAKE_SOURCE_DIR}/src/config.xml > config.doc + DEPENDS ${CMAKE_SOURCE_DIR}/src/config.xml ${CMAKE_SOURCE_DIR}/src/configgen.py + OUTPUT config.doc + WORKING_DIRECTORY ${DOXYDOCS} +) +set_source_files_properties(${DOXYDOCS}/config.doc PROPERTIES GENERATED 1) + +string(TIMESTAMP TODAY "%d-%m-%Y") + +add_custom_command( + COMMAND ${SED} -e "s/DATE/${TODAY}/g" -e "s/VERSION/${VERSION}/g" doxygen.1 > "${PROJECT_BINARY_DIR}/man/doxygen.1" + OUTPUT "${PROJECT_BINARY_DIR}/man/doxygen.1" +) + +add_custom_command( + COMMAND ${SED} -e "s/DATE/${TODAY}/g" -e "s/VERSION/${VERSION}/g" doxywizard.1 > "${PROJECT_BINARY_DIR}/man/doxywizard.1" + OUTPUT "${PROJECT_BINARY_DIR}/man/doxywizard.1" +) + +add_custom_command( + COMMAND ${SED} -e "s/DATE/${TODAY}/g" -e "s/VERSION/${VERSION}/g" doxysearch.1 > "${PROJECT_BINARY_DIR}/man/doxysearch.1" + OUTPUT "${PROJECT_BINARY_DIR}/man/doxysearch.1" +) + +add_custom_command( + COMMAND ${SED} -e "s/DATE/${TODAY}/g" -e "s/VERSION/${VERSION}/g" doxyindexer.1 > "${PROJECT_BINARY_DIR}/man/doxyindexer.1" + OUTPUT "${PROJECT_BINARY_DIR}/man/doxyindexer.1" +) + +install(FILES + "${PROJECT_BINARY_DIR}/man/doxygen.1" + "${PROJECT_BINARY_DIR}/man/doxywizard.1" + "${PROJECT_BINARY_DIR}/man/doxysearch.1" + "${PROJECT_BINARY_DIR}/man/doxyindexer.1" + DESTINATION man/man1 +) + +install(FILES + "${PROJECT_BINARY_DIR}/latex/doxygen_manual.pdf" + DESTINATION "${CMAKE_INSTALL_PREFIX}/${DOC_INSTALL_DIR}" +) + +install(DIRECTORY + "${PROJECT_BINARY_DIR}/html" + DESTINATION "${CMAKE_INSTALL_PREFIX}/${DOC_INSTALL_DIR}" +) + +endif() diff --git a/doc/Doxyfile b/doc/Doxyfile index c57bbe9..ab97227 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -53,3 +53,4 @@ STRIP_CODE_COMMENTS = NO HTML_STYLESHEET = doxygen_manual.css ALIASES = LaTeX="\f$\mbox{\LaTeX}\f$" ALIASES += TeX="\f$\mbox{\TeX}\f$" +LATEX_BATCHMODE = YES diff --git a/doc/Makefile.in b/doc/Makefile.in deleted file mode 100644 index f0c3a03..0000000 --- a/doc/Makefile.in +++ /dev/null @@ -1,39 +0,0 @@ -# -# -# -# Copyright (C) 1997-2014 by Dimitri van Heesch. -# -# Permission to use, copy, modify, and distribute this software and its -# documentation under the terms of the GNU General Public License is hereby -# granted. No representations are made about the suitability of this software -# for any purpose. It is provided "as is" without express or implied warranty. -# See the GNU General Public License for more details. -# -# Documents produced by Doxygen are derivative works derived from the -# input used in their production; they are not affected by this license. - -all: language config.doc FORCE - DOXYGEN_DOCDIR=$(DOXYDOCS); \ - export DOXYGEN_DOCDIR; \ - VERSION=$(VERSION) ; \ - export VERSION; \ - "$(DOXYGEN)/bin/doxygen" - @rm -f ../latex/refman.tex - @cp doxygen_logo*.gif ../html - @cp Makefile.latex ../latex/Makefile - @sed -e "s/\$$VERSION/$(VERSION)/g" doxygen_manual.tex >../latex/doxygen_manual.tex - @sed -e "s/\$$VERSION/$(VERSION)/g" doxygen.sty >../latex/doxygen.sty - @epstopdf doxygen_logo.eps --outfile=../latex/doxygen_logo.pdf - -clean: - rm -rf ../html ../latex *.bak - -language: language.doc - -language.doc: $(wildcard ../src/translator*.h) maintainers.txt language.tpl translator.py - $(PYTHON) translator.py - -config.doc: ../src/config.xml ../src/configgen.py - $(PYTHON) ../src/configgen.py -doc ../src/config.xml > config.doc - -FORCE: diff --git a/doc/Makefile.latex b/doc/Makefile.latex index 803b75d..d4b48ff 100644 --- a/doc/Makefile.latex +++ b/doc/Makefile.latex @@ -1,7 +1,7 @@ # # # -# Copyright (C) 1997-2014 by Dimitri van Heesch. +# Copyright (C) 1997-2015 by Dimitri van Heesch. # # Permission to use, copy, modify, and distribute this software and its # documentation under the terms of the GNU General Public License is hereby diff --git a/doc/Makefile.win_make.in b/doc/Makefile.win_make.in deleted file mode 100644 index 1d22dbf..0000000 --- a/doc/Makefile.win_make.in +++ /dev/null @@ -1,40 +0,0 @@ -# -# -# -# Copyright (C) 1997-2014 by Dimitri van Heesch. -# -# Permission to use, copy, modify, and distribute this software and its -# documentation under the terms of the GNU General Public License is hereby -# granted. No representations are made about the suitability of this software -# for any purpose. It is provided "as is" without express or implied warranty. -# See the GNU General Public License for more details. -# -# Documents produced by Doxygen are derivative works derived from the -# input used in their production; they are not affected by this license. - -all: language config.doc FORCE - @xcopy /s /q /i ..\examples ..\html\examples - set DOXYGEN_DOCDIR=. & \ - set VERSION=$(VERSION) & \ - $(DOXYGEN)\bin\doxygen - @del ..\latex\refman.tex - @copy doxygen_logo*.gif ..\html - @copy Makefile.latex ..\latex\Makefile - @sed -e "s/\$$VERSION/$(VERSION)/g" doxygen_manual.tex >..\latex\doxygen_manual.tex - @sed -e "s/\$$VERSION/$(VERSION)/g" doxygen.sty >..\latex\doxygen.sty - @epstopdf doxygen_logo.eps --outfile=..\latex\doxygen_logo.pdf - -clean: - del /s /q ..\html ..\latex - del translator_report.txt *.bak - -language: language.doc - -language.doc: maintainers.txt language.tpl translator.py - set DOXYGEN_DOCDIR=. & set VERSION=$(VERSION) & python translator.py - -config.doc: ..\src\config.xml ..\src\configgen.py - python ..\src\configgen.py -doc ..\src\config.xml > config.doc - - -FORCE: diff --git a/doc/Makefile.win_nmake.in b/doc/Makefile.win_nmake.in deleted file mode 100644 index 99ac2f1..0000000 --- a/doc/Makefile.win_nmake.in +++ /dev/null @@ -1,41 +0,0 @@ -# -# -# -# Copyright (C) 1997-2014 by Dimitri van Heesch. -# -# Permission to use, copy, modify, and distribute this software and its -# documentation under the terms of the GNU General Public License is hereby -# granted. No representations are made about the suitability of this software -# for any purpose. It is provided "as is" without express or implied warranty. -# See the GNU General Public License for more details. -# -# Documents produced by Doxygen are derivative works derived from the -# input used in their production; they are not affected by this license. - -all: language config.doc FORCE - @xcopy /s /q /i ..\examples ..\html\examples - set DOXYGEN_DOCDIR=. - set VERSION=$(VERSION) - $(DOXYGEN)\bin\doxygen - @del ..\latex\refman.tex - @copy doxygen_logo*.gif ..\html - @copy Makefile.latex ..\latex\Makefile - @sed -e "s/\$$VERSION/$(VERSION)/g" doxygen_manual.tex >..\latex\doxygen_manual.tex - @sed -e "s/\$$VERSION/$(VERSION)/g" doxygen.sty >..\latex\doxygen.sty - @epstopdf doxygen_logo.eps --outfile=..\latex\doxygen_logo.pdf - -clean: - del /s /q ..\html ..\latex - del translator_report.txt *.bak - -language: language.doc - -language.doc: maintainers.txt language.tpl translator.py - set DOXYGEN_DOCDIR=. - set VERSION=$(VERSION) - python translator.py - -config.doc: ../src/config.xml ../src/configgen.py - python ../src/configgen.py -doc ../src/config.xml > config.doc - -FORCE: diff --git a/doc/arch.doc b/doc/arch.doc index fc80659..95cb270 100644 --- a/doc/arch.doc +++ b/doc/arch.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2014 by Dimitri van Heesch. + * Copyright (C) 1997-2015 by Dimitri van Heesch. * * Permission to use, copy, modify, and distribute this software and its * documentation under the terms of the GNU General Public License is hereby diff --git a/doc/autolink.doc b/doc/autolink.doc index b872f7d..9e0d35a 100644 --- a/doc/autolink.doc +++ b/doc/autolink.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2014 by Dimitri van Heesch. + * Copyright (C) 1997-2015 by Dimitri van Heesch. * * Permission to use, copy, modify, and distribute this software and its * documentation under the terms of the GNU General Public License is hereby @@ -112,7 +112,7 @@ \par Example: \verbinclude autolink.cpp \htmlonly - Click <a href="$(DOXYGEN_DOCDIR)/examples/autolink/html/index.html">here</a> + Click <a href="examples/autolink/html/index.html">here</a> for the corresponding HTML documentation that is generated by Doxygen. \endhtmlonly @@ -128,7 +128,7 @@ typedef struct StructName TypeName \par Example: \verbinclude restypedef.cpp \htmlonly - Click <a href="$(DOXYGEN_DOCDIR)/examples/restypedef/html/restypedef_8cpp.html">here</a> + Click <a href="examples/restypedef/html/restypedef_8cpp.html">here</a> for the corresponding HTML documentation that is generated by Doxygen. \endhtmlonly diff --git a/doc/changelog.doc b/doc/changelog.doc index 4810633..a2c540a 100644 --- a/doc/changelog.doc +++ b/doc/changelog.doc @@ -2,6 +2,181 @@ \tableofcontents \section log_1_8 1.8 Series +\subsection log_1_8_10 Release 1.8.10 +\htmlonly +<b>(release date 27-06-2015)</b> +<a name="1.8.10"></a> +<ul> +<li>change the build system to use cmake [<a href="http://github.com/doxygen/doxygen/commit/2e099b1950eee2c3a0d5d8ae4b25575caeb938b1">view</a>], +[<a href="http://github.com/doxygen/doxygen/commit/ba9bb02abf6f6922a83beb2092e7bc270e6f25c1">view</a>], +[<a href="http://github.com/doxygen/doxygen/commit/635d8cf30e702bdf83fe5c96452f8f863d57bdee">view</a>], +[<a href="http://github.com/doxygen/doxygen/commit/51ee91560a9cbaac41cec536dcdeb3e4c32f139a">view</a>], +[<a href="http://github.com/doxygen/doxygen/commit/e775357ae71ecbf02dc93913a923567f31b03681">view</a>], +[<a href="http://github.com/doxygen/doxygen/commit/a0cd6a8e0c19a82e9662f96734c7ba21726794d0">view</a>], +[<a href="http://github.com/doxygen/doxygen/commit/0dc4eda500e803a65a10445719c97d7e523897da">view</a>], +[<a href="http://github.com/doxygen/doxygen/commit/22c0d75d45354979392db5db4e3195570c394e44">view</a>]</li> +<li>Add support for basic XML syntax highlighting. [<a href="http://github.com/doxygen/doxygen/commit/a418518921ba7a99c7221ba7f40d2e791cb207c4">view</a>]</li> +<li>Added documentation for ``` style fenced code block and more robust parsing [<a href="http://github.com/doxygen/doxygen/commit/39ba42c3b21d08ec606eee18ee8b64c67ec6a42a">view</a>]</li> +<li>Added function arguments to the LaTeX toc [<a href="http://github.com/doxygen/doxygen/commit/f5e70723391bacc2d68c19d367ab414e70f786b4">view</a>]</li> +<li>Added missing files and build instructions [<a href="http://github.com/doxygen/doxygen/commit/39228176c052fd293382dc9bc9b4b69b2a6af277">view</a>]</li> +<li>Added missing libraries for building doxysearch on Windows [<a href="http://github.com/doxygen/doxygen/commit/84d94779e76681b63cdcbc362bbe0341cd39064d">view</a>]</li> +<li>Added support for language codes [<a href="http://github.com/doxygen/doxygen/commit/eae07d978b524c787daeab911ca087b47a964577">view</a>]</li> +<li>Added type constraint relations for Java generics to dot graphs and XML output [<a href="http://github.com/doxygen/doxygen/commit/080a465b1321ff93c05ce398cd18a577e0ebae4b">view</a>]</li> +<li>Adding commands \hidecallgraph and \hidecallergraph [<a href="http://github.com/doxygen/doxygen/commit/073e9482a516c24a3d045da049941bfd432f3354">view</a>]</li> +<li>Adjust test script for longer version number [<a href="http://github.com/doxygen/doxygen/commit/c7622971ee485279e8da7634207340ce18b69aaa">view</a>]</li> +<li>Adjusted version in configure script [<a href="http://github.com/doxygen/doxygen/commit/cbd3fa183815191ac5f172a2bac62991642c0b5e">view</a>]</li> +<li>Alignment of project name [<a href="http://github.com/doxygen/doxygen/commit/e7b356d2cb9320a363ac024d39b468e98b223b90">view</a>]</li> +<li>Allow selection of specific translators to compile in at build time [<a href="http://github.com/doxygen/doxygen/commit/faef77a87cecd703e3629a35d2e22efb07e682a0">view</a>]</li> +<li>Based on the report of Peter D. Barnes in the doxygen forum (http://doxygen.10944.n7.nabble.com/doxygen-1-8-9-1-upgrade-errors-td6990.html) [<a href="http://github.com/doxygen/doxygen/commit/9771b807cd776b37f6538dec085442218a5b6a09">view</a>]</li> +<li>Better error message in case of IDL inconsistency [<a href="http://github.com/doxygen/doxygen/commit/a7eef85a89d8772b7ab97a4ba378cc7e78c988cc">view</a>]</li> +<li>Bug <a href="https://bugzilla.gnome.org/show_bug.cgi?id=659590">659590</a> - EXTRA_PACKAGES can't handle package options [<a href="http://github.com/doxygen/doxygen/commit/1c47dd436358ffc7bc76901cddc559b2d8ce233d">view</a>], +[<a href="http://github.com/doxygen/doxygen/commit/ad53cbab6474e11692f2ca1018a821d042df28e6">view</a>]</li> +<li>Bug <a href="https://bugzilla.gnome.org/show_bug.cgi?id=739680">739680</a> - Using HTML entities in PROJECT_NAME [<a href="http://github.com/doxygen/doxygen/commit/8e44571521391403e8d85f893acb926e021e926b">view</a>]</li> +<li>Bug <a href="https://bugzilla.gnome.org/show_bug.cgi?id=742095">742095</a> - Missing documentation after nested C++11 unified initializer [<a href="http://github.com/doxygen/doxygen/commit/c1789f2e5d8421d6028c836ab66afecacff284ef">view</a>]</li> +<li>Bug <a href="https://bugzilla.gnome.org/show_bug.cgi?id=742151">742151</a> - Bogus warning: citelist: Unexpected new line character [<a href="http://github.com/doxygen/doxygen/commit/5c321cbb6359bc1bb875729c08beba2edc084500">view</a>]</li> +<li>Bug <a href="https://bugzilla.gnome.org/show_bug.cgi?id=742230">742230</a> - @todo paragraphs incorrectly placed in rtf output [<a href="http://github.com/doxygen/doxygen/commit/600d5859d7bcb94b08ef656fd427914766ae9afe">view</a>]</li> +<li>Bug <a href="https://bugzilla.gnome.org/show_bug.cgi?id=742235">742235</a> - Bogus message with addtogroup [<a href="http://github.com/doxygen/doxygen/commit/b75af9180ae53f7c7abb94ccf906333169247785">view</a>]</li> +<li>Bug <a href="https://bugzilla.gnome.org/show_bug.cgi?id=742408">742408</a> - Configuring doxyfile to only output docbook produces erroneous warning [<a href="http://github.com/doxygen/doxygen/commit/05fcf8decc25bd2f1a2e7867ee8e5d9da1f08933">view</a>]</li> +<li>Bug <a href="https://bugzilla.gnome.org/show_bug.cgi?id=742427">742427</a> - latex compilation: \backmatter incompatible with COMPACT_LATEX=YES [<a href="http://github.com/doxygen/doxygen/commit/c9067c5bb9a1868e0963dc210cf3b7152c4aa79a">view</a>]</li> +<li>Bug <a href="https://bugzilla.gnome.org/show_bug.cgi?id=742445">742445</a> - Wrong icons in TOC of CHM help [<a href="http://github.com/doxygen/doxygen/commit/8c97e0cd63bcf942ee5b43c9471055a4ea27551c">view</a>]</li> +<li>Bug <a href="https://bugzilla.gnome.org/show_bug.cgi?id=742899">742899</a> - <CAPTION> inside <TABLE> no longer works for LaTex output [<a href="http://github.com/doxygen/doxygen/commit/0599f92d06ff433446f34136ffe2f3d65d6bd109">view</a>]</li> +<li>Bug <a href="https://bugzilla.gnome.org/show_bug.cgi?id=743604">743604</a> - Duplicate anchors from tagfiles [<a href="http://github.com/doxygen/doxygen/commit/1f21c23c57c91ba6901c0de38bb236f7246e88c9">view</a>]</li> +<li>Bug <a href="https://bugzilla.gnome.org/show_bug.cgi?id=743605">743605</a> - Tagfile anchors not generated for enumeration values [<a href="http://github.com/doxygen/doxygen/commit/1d4f37cb13a75ca8bdc49be3558438104e7eef19">view</a>]</li> +<li>Bug <a href="https://bugzilla.gnome.org/show_bug.cgi?id=743675">743675</a> - Non-ascii characters are not emphasised [<a href="http://github.com/doxygen/doxygen/commit/8f67d4f63efd45b0d38502bdf68987d7fc1e92e9">view</a>]</li> +<li>Bug <a href="https://bugzilla.gnome.org/show_bug.cgi?id=744762">744762</a> - Using TAGFILES prevents symbol extraction [<a href="http://github.com/doxygen/doxygen/commit/a735498be5a572236755cc3da65bf4774cbac25c">view</a>]</li> +<li>Bug <a href="https://bugzilla.gnome.org/show_bug.cgi?id=745439">745439</a> - PATCH: please consider making doxygen output byte for byte identical between individual runs by default [<a href="http://github.com/doxygen/doxygen/commit/3f2e8a3067712b025623e4420e6eb161febfd42b">view</a>]</li> +<li>Bug <a href="https://bugzilla.gnome.org/show_bug.cgi?id=745481">745481</a> - Doxygen generates bad "More..." file links for functions within a namespace [<a href="http://github.com/doxygen/doxygen/commit/ea202be55d68af33917658e3fec169da3a7fa7a8">view</a>]</li> +<li>Bug <a href="https://bugzilla.gnome.org/show_bug.cgi?id=745870">745870</a> - [PATCH] QT4's qmake is titled differently on Fedora 21 [<a href="http://github.com/doxygen/doxygen/commit/3bd3ad9f8f4d010e42f0ba8eeab229f44b1ecb1c">view</a>], +[<a href="http://github.com/doxygen/doxygen/commit/a883f65ab94973d4c7948623186159f978517851">view</a>]</li> +<li>Bug <a href="https://bugzilla.gnome.org/show_bug.cgi?id=746226">746226</a> - last enum member not documented [<a href="http://github.com/doxygen/doxygen/commit/50a329c056a2676608f30321a3207ff17ab20abb">view</a>]</li> +<li>Bug <a href="https://bugzilla.gnome.org/show_bug.cgi?id=746417">746417</a> - Nested list in C# XML comments closes outer list prematurely [<a href="http://github.com/doxygen/doxygen/commit/2c679e7d39144dadef2e9fd25772f0e41586e18b">view</a>], +[<a href="http://github.com/doxygen/doxygen/commit/7a0522fafde300f36c3d5264f46c1f70cf35b7b9">view</a>]</li> +<li>Bug <a href="https://bugzilla.gnome.org/show_bug.cgi?id=746614">746614</a> - Bogus warning regarding nested comments [<a href="http://github.com/doxygen/doxygen/commit/e4c0036962d8fa0ea9c1e38dbdb5e91168201f22">view</a>]</li> +<li>Bug <a href="https://bugzilla.gnome.org/show_bug.cgi?id=746619">746619</a> - Bogus warnings in case of anonymous namespace and @todo [<a href="http://github.com/doxygen/doxygen/commit/298ab30b2a2aa0936f4683c9366afd44c00adc60">view</a>]</li> +<li>Bug <a href="https://bugzilla.gnome.org/show_bug.cgi?id=746734">746734</a> - Don't warn about missing documentation for deleted functions. [<a href="http://github.com/doxygen/doxygen/commit/796d6585be58d1c9112422a919f49d1998dc672c">view</a>], +[<a href="http://github.com/doxygen/doxygen/commit/ac576bd974ac27bc1f395e8ae6c77b19f800b6db">view</a>]</li> +<li>Bug <a href="https://bugzilla.gnome.org/show_bug.cgi?id=747111">747111</a> - Table of content incorrect with escaped symbols [<a href="http://github.com/doxygen/doxygen/commit/5cdf62661c88b5f0c135337da4d6e58581aad037">view</a>]</li> +<li>Bug <a href="https://bugzilla.gnome.org/show_bug.cgi?id=747780">747780</a> - man output should escape minus signs [<a href="http://github.com/doxygen/doxygen/commit/3608a668b3892eaa4f7b2e4b29b833ede24ceee7">view</a>]</li> +<li>Bug <a href="https://bugzilla.gnome.org/show_bug.cgi?id=748208">748208</a> - Bug #313527 regression - Enum in bitfield is not parsed properly. [<a href="http://github.com/doxygen/doxygen/commit/528bb8054ca362843630ec261ca6e6990a206081">view</a>], +[<a href="http://github.com/doxygen/doxygen/commit/7b2d77abb73288bdd48ca04720fd6779e0bf94c2">view</a>]</li> +<li>Bug <a href="https://bugzilla.gnome.org/show_bug.cgi?id=750016">750016</a> - FILE_PATTERNS ignores arbitrary extensions [<a href="http://github.com/doxygen/doxygen/commit/52cb086da66533332962f2bf9cb35772e980c092">view</a>]</li> +<li>Bug <a href="https://bugzilla.gnome.org/show_bug.cgi?id=751455">751455</a> - class scoped enum documentation appearing at group level instead of class level [<a href="http://github.com/doxygen/doxygen/commit/e4a9d06d7871f24dd6e37ecac6addae729e6d721">view</a>]</li> +<li>Build fixes for windows build [<a href="http://github.com/doxygen/doxygen/commit/5446770855a8286092abdd91d9069cb3191c209d">view</a>]</li> +<li>Bump copyright year [<a href="http://github.com/doxygen/doxygen/commit/e11b48785323017bf1d81e91e8133d7f3ba1f243">view</a>]</li> +<li>Bump version in configure script [<a href="http://github.com/doxygen/doxygen/commit/97342f92e111d7aa3e423a128379a6018820ce6c">view</a>]</li> +<li>Cleanup & adapt travis config [<a href="http://github.com/doxygen/doxygen/commit/5f67c67323bff27751ba07c417ba99180fa0d762">view</a>]</li> +<li>Consistency in handling HTML and LaTeX in respect to header and footer [<a href="http://github.com/doxygen/doxygen/commit/be5cc75ffc2e0a95ecbf0ce8d918b070c276d3e5">view</a>]</li> +<li>Correct string buffer sizes for RTF output, such that the string is always correctly sized. [<a href="http://github.com/doxygen/doxygen/commit/bc8e705cf90cecdff8a247264c249ffed1d2af4a">view</a>]</li> +<li>Crash in case of non generic interface in Fortran [<a href="http://github.com/doxygen/doxygen/commit/7d3a2abf0137c5257eeb0a8e0f76381b79f1e7bb">view</a>]</li> +<li>Documentation HTML Header, Footer, and Stylesheet changes [<a href="http://github.com/doxygen/doxygen/commit/1dded5c92a13f9db60fc630cbe5f2cc5ad9bede0">view</a>], [<a href="http://github.com/doxygen/doxygen/commit/478207365d7f09f0e676a76f654502c084806e4e">view</a>]</li> +<li>Documenting RESULT variable of Fortran FUNCTION [<a href="http://github.com/doxygen/doxygen/commit/21f9e87db8085fb1b5e0a9a9a25dee159b3fd324">view</a>], [<a href="http://github.com/doxygen/doxygen/commit/4d52beec3760244d959ab4d5528aea1acba505e7">view</a>]</li> +<li>Doxygen LaTeX / PDF links point to page 1 [<a href="http://github.com/doxygen/doxygen/commit/e34913dcbe0bee2c3e21d6e21b2bcc6970003a5c">view</a>]</li> +<li>Enable relative paths referenced source files [<a href="http://github.com/doxygen/doxygen/commit/ed178335e8c123b58c4fee24766bceae0fc80aa2">view</a>]</li> +<li>Escape "@" in names as it is not allowed in XML / Docbook names (comming from anon namespaces) [<a href="http://github.com/doxygen/doxygen/commit/65c35c435ae93d5f39c3ddec93008b2f544544ca">view</a>]</li> +<li>Fix for bug 746673. [<a href="http://github.com/doxygen/doxygen/commit/effbbcc72295f5843377ddce2794bcf6e7000322">view</a>]</li> +<li>Fix for building diagram example conditionally [<a href="http://github.com/doxygen/doxygen/commit/f415b624a6cf6b9e577ec6131a23cb4a0e830aaf">view</a>]</li> +<li>Fix for issue 744670 [<a href="http://github.com/doxygen/doxygen/commit/0d684381ac40574f6a948c56eb2da0445c3ee3bf">view</a>]</li> +<li>Fix for issue 744671 [<a href="http://github.com/doxygen/doxygen/commit/192f9e8bf78e10c9d97e08264b1c76c8aa4edf2b">view</a>]</li> +<li>Fix for rendering the template parameters of members of variadic template classes. [<a href="http://github.com/doxygen/doxygen/commit/32093bcca82c7d3a4df4670f52340033e9f16b62">view</a>]</li> +<li>Fix missing brief documentation for overload and specialization functions [<a href="http://github.com/doxygen/doxygen/commit/c604aef8a6465f38f8f04276194a66a4e044dc84">view</a>]</li> +<li>Fix nesting of XML tag "literallayout" for docbook output of enums. [<a href="http://github.com/doxygen/doxygen/commit/3abac31c525e6cf6898a1e8deb5c73f2a2ff5a8a">view</a>]</li> +<li>Fix parsing of ODL-style properties [<a href="http://github.com/doxygen/doxygen/commit/6a8bef8852eb22558b3559ebe96d9e06e6cadfa7">view</a>]</li> +<li>Fix potential null pointer dereference in src/classdef.cpp [<a href="http://github.com/doxygen/doxygen/commit/5743848928ffaeccaaef24dac051aaa9acf2c4b7">view</a>]</li> +<li>Fix potential null pointer dereference in src/context.cpp [<a href="http://github.com/doxygen/doxygen/commit/2690774f87b9fcb12b35153de82cde22248b3949">view</a>]</li> +<li>Fixed a couple of cases where sharing string data could lead to corruption [<a href="http://github.com/doxygen/doxygen/commit/312bef563a5be72f6423377247db1b80044bf711">view</a>]</li> +<li>Fixed code reachability bug found by coverity in translator_fi.h [<a href="http://github.com/doxygen/doxygen/commit/80d09775da9a99a3bc58704ffd055547c6b03043">view</a>]</li> +<li>Fixed compilation issue on Windows [<a href="http://github.com/doxygen/doxygen/commit/d75455eef7c91f11c2b9061d9a086ce93c4231b2">view</a>]</li> +<li>Fixed issue accessing uninitialized buffer under certain conditions. [<a href="http://github.com/doxygen/doxygen/commit/49f6c63aba4d77cd14fa205bee4bf427cefdaa44">view</a>]</li> +<li>Fixed potential crash while generating dot graphs [<a href="http://github.com/doxygen/doxygen/commit/50f82c94b9bf1ff982f9ddd8b9a88fb91d9e0bec">view</a>]</li> +<li>Fixed potential string buffer issue for dot graphs [<a href="http://github.com/doxygen/doxygen/commit/6b24aba8fce772d9e46e3174a655281eeb44ad84">view</a>]</li> +<li>Fixed regression due to buffer resizing while generating RTF. [<a href="http://github.com/doxygen/doxygen/commit/a1f2872ef098cfcc526002b9c9d533da6f2775b5">view</a>]</li> +<li>Fixed regression in argument processing [<a href="http://github.com/doxygen/doxygen/commit/ae8f618d140b4368045d286a682df3f6de7b2960">view</a>]</li> +<li>Fixed type in printdocvisitor.h [<a href="http://github.com/doxygen/doxygen/commit/c9465bd210d8250a5439f22bf564c187cd45e968">view</a>]</li> +<li>Fixed typos in comments. [<a href="http://github.com/doxygen/doxygen/commit/b82320a6f57519443c46e5e3044fef97b1f8f618">view</a>]</li> +<li>Fixes for showing type constraint relations [<a href="http://github.com/doxygen/doxygen/commit/95375152974fa7e0e4d4cec7007d942dd5e9615e">view</a>]</li> +<li>Fortran FUNCTION source code [<a href="http://github.com/doxygen/doxygen/commit/25a90990662449808c5ba58c243a7835d13ba750">view</a>], [<a href="http://github.com/doxygen/doxygen/commit/e7a6a682137a82dbdf847b1879f320ece4f3642f">view</a>]</li> +<li>Fortran: code color GOTO as flow keyword. [<a href="http://github.com/doxygen/doxygen/commit/8090675790ad9265bcffdf07ab4d48fc8c037276">view</a>]</li> +<li>Fortran: fixed format position 73 and further is comment [<a href="http://github.com/doxygen/doxygen/commit/557ad21ce28d093044101eb8bee2c4df1621da7a">view</a>], [<a href="http://github.com/doxygen/doxygen/commit/eb92c064b33bf9f303233210b9693215b0fb7f9d">view</a>]</li> +<li>Fortran: warning message about not documented module member [<a href="http://github.com/doxygen/doxygen/commit/dcdd35ce2a0cda024525298a9a20d6c746539e6d">view</a>]</li> +<li>Guarded debug prints against printing a NULL pointer. [<a href="http://github.com/doxygen/doxygen/commit/0831c71c05c9204839e187759f13303e64783730">view</a>]</li> +<li>HTML entity &deg; gives problems in LaTeX [<a href="http://github.com/doxygen/doxygen/commit/072383ed1c6fcfff7a7619d92ce3a8cb0b91fff9">view</a>]</li> +<li>Help message regarding layout file [<a href="http://github.com/doxygen/doxygen/commit/7569f42d95332a5948e9d35e94e88d56d11634a9">view</a>],[<a href="http://github.com/doxygen/doxygen/commit/ad0e5fe14dce093e3b00ca677849cacbc2d657b7">view</a>]</li> +<li>Internal debug option -d lex is not described [<a href="http://github.com/doxygen/doxygen/commit/00a91ae9fabe7783260c7c3fcdfec5b1ead49350">view</a>], [<a href="http://github.com/doxygen/doxygen/commit/ebe3e8ec4a09edbb8a5b2dde88b6c479b03c0be9">view</a>]</li> +<li>Internal doxygen docs gives: warning: Unsupported xml/html tag <...> found [<a href="http://github.com/doxygen/doxygen/commit/e366acaf0c27ce43ec80a70c0667c27cd5ef9d29">view</a>]</li> +<li>Missing cross reference link [<a href="http://github.com/doxygen/doxygen/commit/213e680537303959f29b2424d40d74ecf66cb3f6">view</a>]</li> +<li>Patch fixing a typo in Pull Request 307 [<a href="http://github.com/doxygen/doxygen/commit/6913c67ff1f9f20a71333f78cacd87a9e0c7756f">view</a>], [<a href="http://github.com/doxygen/doxygen/commit/eac0fd660bffe62ae29a190308bf21b21d49647b">view</a>]</li> +<li>Prevent example.tag from being regenerated [<a href="http://github.com/doxygen/doxygen/commit/d49604f814ceb22f81571d8ca99540e62cfa979a">view</a>]</li> +<li>Problem running tests under Windows [<a href="http://github.com/doxygen/doxygen/commit/9bd54df7ba7dd15783f5a9180c85a7137dcdbc08">view</a>]</li> +<li>Remove the new line after @startuml in generated pu file [<a href="http://github.com/doxygen/doxygen/commit/edf8dbbbc17e65e2eb97b5c9b4763a04969017fe">view</a>]</li> +<li>Remove unreachable code [<a href="http://github.com/doxygen/doxygen/commit/d3e7b06f3a82780083e27bb83360ed9496df9f8d">view</a>]</li> +<li>Remove unused local and static global variables [<a href="http://github.com/doxygen/doxygen/commit/d03e4c2ae1864c6f27a4341449ce97133aeb6847">view</a>]</li> +<li>Remove wrong </File> [<a href="http://github.com/doxygen/doxygen/commit/e8cef724a1f40896f9c6294d6f410e240b6365ee">view</a>], [<a href="http://github.com/doxygen/doxygen/commit/efd55ae1787f8f7ec35761849dc7cfd3175f8b33">view</a>]</li> +<li>Removed OS version check for MACOSX (was not used anywhere) [<a href="http://github.com/doxygen/doxygen/commit/1e3e9f03e746d4ac46c9c7b1b80e7e3100ee42f0">view</a>]</li> +<li>Removed dbus XML parser, various refinements [<a href="http://github.com/doxygen/doxygen/commit/551012f2647c53d8532d638361011d003d5b81f3">view</a>], [<a href="http://github.com/doxygen/doxygen/commit/bf4aee305879406d9057864ab7f8938e01ca8bd0">view</a>]</li> +<li>Removed old build files, added install targets and other options [<a href="http://github.com/doxygen/doxygen/commit/7bcf8e9a379ec0599160e5562f07b93f8fb9557a">view</a>]</li> +<li>Repair Doxygen generate invalid styleSheetFile and extensionsFile of RTF [<a href="http://github.com/doxygen/doxygen/commit/0d208bc1c9a32718a93eb9911220ba72ad27fb9a">view</a>]</li> +<li>Replace to_c_cmd by resource compiler [<a href="http://github.com/doxygen/doxygen/commit/2e39e5c7c1427ac6b24c64b7ef01be8d5a20092b">view</a>]</li> +<li>Restore deleted file [<a href="http://github.com/doxygen/doxygen/commit/dfe93f9fde39167eae2aeeab929641a9c56cc916">view</a>]</li> +<li>Showing grey/gray in documentation [<a href="http://github.com/doxygen/doxygen/commit/320ebb35dd4a615a7a692d71de4587be9ce8b99b">view</a>]</li> +<li>Suggestion to use stripPrefix has been implemented for RESULT. For consistency also implemented for arguments. [<a href="http://github.com/doxygen/doxygen/commit/610bdb67c4db775debf26d85091383938d946f3d">view</a>], [<a href="http://github.com/doxygen/doxygen/commit/6720a714461b9454c7cdbae7ceff7eb735feeb3b">view</a>]</li> +<li>Support diff that returns "No differences encountered" when comparing test results [<a href="http://github.com/doxygen/doxygen/commit/4716f426332d02eb6841c509658b8a709cce9318">view</a>]</li> +<li>Support generating index-color PNG files [<a href="http://github.com/doxygen/doxygen/commit/a09ffed2f603699955c18c19e0d3e782fb61d93f">view</a>]</li> +<li>Switched back to version 6.2 of JavaCC for VHDL parser generation. [<a href="http://github.com/doxygen/doxygen/commit/088896f27f460b6ac03c2d64df148e3617c1e519">view</a>]</li> +<li>Tcl: fix for extra line breaks in source browser introduced by commit 312bef5 [<a href="http://github.com/doxygen/doxygen/commit/3cc116ba2250e6946773ec22c6c7c6557773d28e">view</a>]</li> +<li>TranslatorSwedish updated [<a href="http://github.com/doxygen/doxygen/commit/eaa19e3a439a4652023b47b0cf47c7303484ef5d">view</a>]</li> +<li>Update of search from "endless search to 'Character search: criterion. [<a href="http://github.com/doxygen/doxygen/commit/a0820f29e60be1555b5b0c92a975bf334b6f5258">view</a>]</li> +<li>Update translator_cn.h [<a href="http://github.com/doxygen/doxygen/commit/a88d3549373990bfac09f936748577fc5c59d240">view</a>]</li> +<li>Updated changelog for 1.8.9.1 [<a href="http://github.com/doxygen/doxygen/commit/f8671a4520350fe38f986fdd199c2344452e7a01">view</a>]</li> +<li>Updated installation section of the manual [<a href="http://github.com/doxygen/doxygen/commit/db6a3ab2761a328e74fdccf243ff148af7623062">view</a>]</li> +<li>Various VHDL related fixes [<a href="http://github.com/doxygen/doxygen/commit/34b00c442308efe169cc89fad62588fdce1d84e8">view</a>], +[<a href="http://github.com/doxygen/doxygen/commit/3eed7a5c5b330736b508c722c9614c774a678ef1">view</a>], +[<a href="http://github.com/doxygen/doxygen/commit/530647f76a7660a406d102269dc041b00b0e3d4e">view</a>]</li> +<li>Various minor changes [<a href="http://github.com/doxygen/doxygen/commit/f63d9ed958d2c06717434e1a90e6417cf2d60f6b">view</a>]</li> +<li>Warning message multiple mainpages [<a href="http://github.com/doxygen/doxygen/commit/17fdd71a0f7a02e8b72eaf86d67bc142210a7059">view</a>]</li> +<li>Warnings without filename [<a href="http://github.com/doxygen/doxygen/commit/da3faf6b93fd3eb4e751d2c0cbd4ed9ceae7922b">view</a>]</li> +<li>add support for github flavored fenced code blocks [<a href="http://github.com/doxygen/doxygen/commit/288ea42fc27389160c20912003a7972e21195265">view</a>]</li> +<li>added HHC.exe own output to the debug output when extcmd flag enabled [<a href="http://github.com/doxygen/doxygen/commit/4438e24b478de1fd97ccc81a3a9f7651124e1c63">view</a>]</li> +<li>doc/translator.py -- minor updates [<a href="http://github.com/doxygen/doxygen/commit/1ccc93fd699b34b7a89acecf9e59a526a5972bb8">view</a>]</li> +<li>drop #include <unistd.h> [<a href="http://github.com/doxygen/doxygen/commit/1dd0cf03f5bf173fa4ac3bb8279d12fff1b98eb7">view</a>]</li> +<li>fix *.l for three backticks [<a href="http://github.com/doxygen/doxygen/commit/bb93db0d60fd4cd123dfc886ecd20167068db6ba">view</a>]</li> +<li>fix enum brief description in RTF output [<a href="http://github.com/doxygen/doxygen/commit/87429a2609b822d2b08ec17fb2a20464a5043c9e">view</a>]</li> +<li>fix for CHM TOC "Classes" entry to point to annotated file [<a href="http://github.com/doxygen/doxygen/commit/700a9ac3c177fdef25b9b00ed6bb5e0ea963d236">view</a>]</li> +<li>fix for src/translator_tw.h by Gary Lee (translation cleaned) [<a href="http://github.com/doxygen/doxygen/commit/d101790db5e64a64f4db0e46391bbb1b0dadc8b1">view</a>]</li> +<li>increase the size of l when result is modified [<a href="http://github.com/doxygen/doxygen/commit/dd0d738683029f80a42b6673e0b1b1228bebfce3">view</a>]</li> +<li>move layout_default.xml to templates/html/ [<a href="http://github.com/doxygen/doxygen/commit/45ebb6ff4846255ad7209e3bec7cd4fe0544ffd5">view</a>]</li> +<li>runtests.pl: mmn version has dash as separator [<a href="http://github.com/doxygen/doxygen/commit/f5efa2f383fe89b53bd8fc27b2116e8636417ebf">view</a>]</li> +<li>specify that doxygen searches files in INPUT tag [<a href="http://github.com/doxygen/doxygen/commit/0971dc7771be1b386a204c3d11515f7d0f5af427">view</a>]</li> +<li>sqlite3: add regexp searches to search.py [<a href="http://github.com/doxygen/doxygen/commit/13dd6d635e7ba2beb26a0d2ee8542ac63d1c7973">view</a>]</li> +<li>sqlite3: add schema comments [<a href="http://github.com/doxygen/doxygen/commit/ef5d48d93f5565ebca9aae4ba9d6633c32719ecc">view</a>]</li> +<li>sqlite3: fix constness [<a href="http://github.com/doxygen/doxygen/commit/90d89d8a2a2be931742c7291cd70e4a980035ae1">view</a>]</li> +<li>version.py pass configure file path as parameter [<a href="http://github.com/doxygen/doxygen/commit/75e8f4c80ab5c06a33eaaf7ec587ee35ed9c1b1a">view</a>]</li> +<li>xml: use STRIP_FROM_PATH on @file attributes. [<a href="http://github.com/doxygen/doxygen/commit/29ae707794042a97412eaa137fa7b30f2367294d">view</a>], [<a href="http://github.com/doxygen/doxygen/commit/5a0379944f8bdf883fdb25e94e0cdb1e5d2f4366">view</a>]</li> +</ul> +\endhtmlonly + +\subsection log_1_8_9_1 Release 1.8.9.1 +\htmlonly +<b>(release date 04-01-2015)</b> +<a name="1.8.9.1"></a> +<ul> +<li>Fixed a couple of cases where sharing string data could lead to corruption [<a href="http://github.com/doxygen/doxygen/commit/312bef563a5be72f6423377247db1b80044bf711">view</a>]</li> +<li>Various VHDL related fixes [<a href="http://github.com/doxygen/doxygen/commit/34b00c442308efe169cc89fad62588fdce1d84e8">view</a>]</li> +<li>Bug <a href="https://bugzilla.gnome.org/show_bug.cgi?id=742151">742151</a> - Bogus warning: citelist: Unexpected new line character [<a href="http://github.com/doxygen/doxygen/commit/5c321cbb6359bc1bb875729c08beba2edc084500">view</a>]</li> +<li>Bug <a href="https://bugzilla.gnome.org/show_bug.cgi?id=742230">742230</a> - @todo paragraphs incorrectly placed in rtf output [<a href="http://github.com/doxygen/doxygen/commit/600d5859d7bcb94b08ef656fd427914766ae9afe">view</a>]</li> +<li>Bug <a href="https://bugzilla.gnome.org/show_bug.cgi?id=742235">742235</a> - Bogus message with addtogroup [<a href="http://github.com/doxygen/doxygen/commit/b75af9180ae53f7c7abb94ccf906333169247785">view</a>]</li> +<li>Documentation HTML Header, Footer, and Stylesheet changes [<a href="http://github.com/doxygen/doxygen/commit/478207365d7f09f0e676a76f654502c084806e4e">view</a>]</li> +<li>Documenting RESULT variable of Fortran FUNCTION [<a href="http://github.com/doxygen/doxygen/commit/4d52beec3760244d959ab4d5528aea1acba505e7">view</a>]</li> +<li>Fix potential null pointer dereference in src/context.cpp [<a href="http://github.com/doxygen/doxygen/commit/2690774f87b9fcb12b35153de82cde22248b3949">view</a>]</li> +<li>Fixed compilation issue on Windows [<a href="http://github.com/doxygen/doxygen/commit/d75455eef7c91f11c2b9061d9a086ce93c4231b2">view</a>]</li> +<li>Fortran FUNCTION source code [<a href="http://github.com/doxygen/doxygen/commit/25a90990662449808c5ba58c243a7835d13ba750">view</a>]</li> +<li>Fortran: code color GOTO as flow keyword. [<a href="http://github.com/doxygen/doxygen/commit/8090675790ad9265bcffdf07ab4d48fc8c037276">view</a>]</li> +<li>Help message regarding layout file [<a href="http://github.com/doxygen/doxygen/commit/7569f42d95332a5948e9d35e94e88d56d11634a9">view</a>]</li> +<li>Remove unused local and static global variables [<a href="http://github.com/doxygen/doxygen/commit/d03e4c2ae1864c6f27a4341449ce97133aeb6847">view</a>]</li> +<li>Suggestion to use stripPrefix has been implemented for RESULT. For consistency also implemented for arguments. [<a href="http://github.com/doxygen/doxygen/commit/6720a714461b9454c7cdbae7ceff7eb735feeb3b">view</a>]</li> +<li>Switched back to version 6.2 of JavaCC for VHDL parser generation. [<a href="http://github.com/doxygen/doxygen/commit/088896f27f460b6ac03c2d64df148e3617c1e519">view</a>]</li> +</ul> +\endhtmlonly + \subsection log_1_8_9 Release 1.8.9 \htmlonly <b>(release date 25-12-2014)</b> diff --git a/doc/commands.doc b/doc/commands.doc index 12fe9a6..f2150d1 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2014 by Dimitri van Heesch. + * Copyright (C) 1997-2015 by Dimitri van Heesch. * * Permission to use, copy, modify, and distribute this software and its * documentation under the terms of the GNU General Public License is hereby @@ -49,8 +49,8 @@ documentation: \refitem cmdbrief \\brief \refitem cmdbug \\bug \refitem cmdc \\c -\refitem cmdcallgraph \\callgraph \refitem cmdcallergraph \\callergraph +\refitem cmdcallgraph \\callgraph \refitem cmdcategory \\category \refitem cmdcite \\cite \refitem cmdclass \\class @@ -104,6 +104,8 @@ documentation: \refitem cmdfile \\file \refitem cmdfn \\fn \refitem cmdheaderfile \\headerfile +\refitem cmdhidecallergraph \\hidecallergraph +\refitem cmdhidecallgraph \\hidecallgraph \refitem cmdhideinitializer \\hideinitializer \refitem cmdhtmlinclude \\htmlinclude \refitem cmdhtmlonly \\htmlonly @@ -273,7 +275,26 @@ Structural indicators \note The completeness (and correctness) of the call graph depends on the doxygen code parser which is not perfect. - \sa section \ref cmdcallergraph "\\callergraph". + \sa section \ref cmdcallergraph "\\callergraph", + section \ref cmdhidecallgraph "\\hidecallgraph", + section \ref cmdhidecallergraph "\\hidecallergraph" and + option \ref cfg_call_graph "CALL_GRAPH" + +<hr> +\section cmdhidecallgraph \\hidecallgraph + + \addindex \\hidecallgraph + When this command is put in a comment block of a function or method + and then doxygen will not generate a call graph for that function. The + call graph will not be generated regardless of the value of + \ref cfg_call_graph "CALL_GRAPH". + \note The completeness (and correctness) of the call graph depends on the + doxygen code parser which is not perfect. + + \sa section \ref cmdcallergraph "\\callergraph", + section \ref cmdcallgraph "\\callgraph", + section \ref cmdhidecallergraph "\\hidecallergraph" and + option \ref cfg_call_graph "CALL_GRAPH" <hr> \section cmdcallergraph \\callergraph @@ -287,7 +308,26 @@ Structural indicators \note The completeness (and correctness) of the caller graph depends on the doxygen code parser which is not perfect. - \sa section \ref cmdcallgraph "\\callgraph". + \sa section \ref cmdcallgraph "\\callgraph", + section \ref cmdhidecallgraph "\\hidecallgraph", + section \ref cmdhidecallergraph "\\hidecallergraph" and + option \ref cfg_caller_graph "CALLER_GRAPH" + +<hr> +\section cmdhidecallergraph \\hidecallergraph + + \addindex \\hidecallergraph + When this command is put in a comment block of a function or method + and then doxygen will not generate a caller graph for that function. The + caller graph will not be generated regardless of the value of + \ref cfg_caller_graph "CALLER_GRAPH". + \note The completeness (and correctness) of the caller graph depends on the + doxygen code parser which is not perfect. + + \sa section \ref cmdcallergraph "\\callergraph", + section \ref cmdcallgraph "\\callgraph", + section \ref cmdhidecallgraph "\\hidecallgraph" and + option \ref cfg_caller_graph "CALLER_GRAPH" <hr> \section cmdcategory \\category <name> [<header-file>] [<header-name>] @@ -320,7 +360,7 @@ Structural indicators \par Example: \verbinclude class.h \htmlonly - Click <a href="$(DOXYGEN_DOCDIR)/examples/class/html/index.html">here</a> + Click <a href="examples/class/html/index.html">here</a> for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly @@ -334,7 +374,7 @@ Structural indicators \par Example: \verbinclude define.h \htmlonly - Click <a href="$(DOXYGEN_DOCDIR)/examples/define/html/define_8h.html">here</a> + Click <a href="examples/define/html/define_8h.html">here</a> for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly @@ -382,7 +422,7 @@ Structural indicators \par Example: \verbinclude enum.h \htmlonly - Click <a href="$(DOXYGEN_DOCDIR)/examples/enum/html/class_test.html">here</a> + Click <a href="examples/enum/html/class_test.html">here</a> for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly @@ -413,7 +453,7 @@ Structural indicators Where the example file \c example_test.cpp looks as follows: \verbinclude example_test.cpp \htmlonly - Click <a href="$(DOXYGEN_DOCDIR)/examples/example/html/examples.html">here</a> + Click <a href="examples/example/html/examples.html">here</a> for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly @@ -439,7 +479,7 @@ Structural indicators The file \c manual.c in the example directory shows how to use this command. \htmlonly - Click <a href="$(DOXYGEN_DOCDIR)/examples/manual/html/index.html">here</a> + Click <a href="examples/manual/html/index.html">here</a> for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly @@ -463,7 +503,7 @@ Structural indicators \par Example: \verbinclude file.h \htmlonly - Click <a href="$(DOXYGEN_DOCDIR)/examples/file/html/file_8h.html">here</a> + Click <a href="examples/file/html/file_8h.html">here</a> for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly @@ -497,7 +537,7 @@ Structural indicators \par Example: \verbinclude func.h \htmlonly - Click <a href="$(DOXYGEN_DOCDIR)/examples/func/html/class_test.html">here</a> + Click <a href="examples/func/html/class_test.html">here</a> for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly @@ -579,7 +619,7 @@ Structural indicators The file \c manual.c in the example directory shows how to use this command. \htmlonly - Click <a href="$(DOXYGEN_DOCDIR)/examples/manual/html/index.html">here</a> + Click <a href="examples/manual/html/index.html">here</a> for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly @@ -679,7 +719,7 @@ Structural indicators The file \c manual.c in the example directory shows how to use this command. \htmlonly - Click <a href="$(DOXYGEN_DOCDIR)/examples/manual/html/index.html">here</a> + Click <a href="examples/manual/html/index.html">here</a> for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly @@ -747,7 +787,7 @@ Structural indicators \par Example: \verbinclude examples/overload.cpp \htmlonly - Click <a href="$(DOXYGEN_DOCDIR)/examples/overload/html/class_test.html">here</a> + Click <a href="examples/overload/html/class_test.html">here</a> for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly @@ -771,7 +811,7 @@ Structural indicators \par Example: \verbinclude page.doc \htmlonly - Click <a href="$(DOXYGEN_DOCDIR)/examples/page/html/pages.html">here</a> + Click <a href="examples/page/html/pages.html">here</a> for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly @@ -927,7 +967,7 @@ Structural indicators \par Example: \verbinclude relates.cpp \htmlonly - Click <a href="$(DOXYGEN_DOCDIR)/examples/relates/html/class_string.html">here</a> + Click <a href="examples/relates/html/class_string.html">here</a> for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly @@ -1078,7 +1118,7 @@ Section indicators \par Example: \verbinclude author.cpp \htmlonly - Click <a href="$(DOXYGEN_DOCDIR)/examples/author/html/class_some_nice_class.html">here</a> + Click <a href="examples/author/html/class_some_nice_class.html">here</a> for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly @@ -1421,7 +1461,7 @@ ALIASES = "english=\if english" \ \par Example: \verbinclude par.cpp \htmlonly - Click <a href="$(DOXYGEN_DOCDIR)/examples/par/html/class_test.html">here</a> + Click <a href="examples/par/html/class_test.html">here</a> for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly @@ -2027,7 +2067,7 @@ Commands for displaying examples Where the example file \c example_test.cpp looks as follows: \verbinclude example_test.cpp \htmlonly - Click <a href="$(DOXYGEN_DOCDIR)/examples/include/html/example.html">here</a> + Click <a href="examples/include/html/example.html">here</a> for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly @@ -3190,7 +3230,7 @@ class Receiver \addindex \\\. This command writes a dot (`.`) to the output. This can be useful to - prevent ending a brief description when JAVADOC_AUTOBRIEF is enabled + prevent ending a brief description when \ref cfg_javadoc_autobrief "JAVADOC_AUTOBRIEF" is enabled or to prevent starting a numbered list when the dot follows a number at the start of a line. diff --git a/doc/custcmd.doc b/doc/custcmd.doc index db41f95..8ac2a65 100644 --- a/doc/custcmd.doc +++ b/doc/custcmd.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2014 by Dimitri van Heesch. + * Copyright (C) 1997-2015 by Dimitri van Heesch. * * Permission to use, copy, modify, and distribute this software and its * documentation under the terms of the GNU General Public License is hereby diff --git a/doc/customize.doc b/doc/customize.doc index 46b1d8b..f98ce0b 100644 --- a/doc/customize.doc +++ b/doc/customize.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2014 by Dimitri van Heesch. + * Copyright (C) 1997-2015 by Dimitri van Heesch. * * Permission to use, copy, modify, and distribute this software and its * documentation under the terms of the GNU General Public License is hereby @@ -117,9 +117,9 @@ This will create 3 files: You should edit these files and then reference them from the config file. - \ref cfg_html_header "HTML_HEADER" = \c header.html - \ref cfg_html_footer "HTML_FOOTER" = \c footer.html -- \ref cfg_html_stylesheet "HTML_STYLESHEET" = \c customdoxygen.css <b>←obsolete</b> +- \ref cfg_html_extra_stylesheet "HTML_EXTRA_STYLESHEET" = \c my_customdoxygen.css -\note it is not longer recommended to use HTML_STYLESHEET this way, +\note it is not longer recommended to use \ref cfg_html_stylesheet "HTML_STYLESHEET", as it make it difficult to upgrade to a newer version of doxygen. Use \ref cfg_html_extra_stylesheet "HTML_EXTRA_STYLESHEET" instead. diff --git a/doc/dbusxml.doc b/doc/dbusxml.doc deleted file mode 100644 index e487126..0000000 --- a/doc/dbusxml.doc +++ /dev/null @@ -1,149 +0,0 @@ -/*! \page dbusxml DBus XML output format - -\addindex dbusxml - -<p>Doxygen can generate documentation for DBus XML files. This way -DBus interfaces can be annotated with doxygen style comments, and -without writing custom XML parsers. Doxygen extracts its text from -all XML comments starting with '*' or '!'. An additional '<' can be -used to assign the documentation string to the previous entity instead -of the one following the comment. - -Note that before the parsing of DBus XML file works one has to -assign the .xml extension to the DBus XML parser using the -following configuration option: - -\verbatim -EXTENSION_MAPPING = xml=dbusxml -\endverbatim - -\section dbusxml_supported Supported XML elements and attributes - -<p>The following DBus XML elemets can be annotated: - -<ul> -<li><b>interface</b> - -<li><b>method</b> or <b>signal</b> - -<li><b>arg</b> - -<li><b>property</b> - -</ul> - -Additional elements are supported. These are available once -the xmlns "http://psiamp.org/dtd/doxygen_dbusxml.dtd" is -available. - -<ul> -<li><b>namespace</b>: This can be used to group other more of the -additional elemets. This element requires a <b>name</b> attribute. - -<li><b>enum</b> is used to define enums. <b>value</b> element is - then used to define the individual values in the enum. This element - requires the <b>name</b> and <b>type</b> attributes. A - optional <b>named-type</b> attribute is allowed, referrencing typed - previously defined by one of the additional elements. A enum name - can be used anywhere a type is required using the <b>named-type</b> - attribute. - -<li><b>flagset</b> is used to define sets of flags. Required and - optional attributes are identical to the ones used by <b>enum</b>. - While <b>enum</b>s assume the values to be consecutive, while - a <b>flagset</b> is values suitable for flags. A flagset name - can be used anywhere a type is required using the <b>named-type</b> - attribute. - -<li><b>struct</b> is used to define structures. A <b>name</b> - attribute is required. - -<li><b>member</b> is used to define members of <b>structs</b>. It - is valid inside <b>struct</b> elements. This - element requires <b>name</b> and <b>type</b> attributes. In - addition to (or even instead of) the <b>type</b> attribute a - <b>named-type</b> attribute may be used to reference types defined - by <b>enum</b>, <b>flagset</b> or <b>struct</b>. - -\section dbusxml_example Example - -<pre> -<?xml version="1.0" ?> -<!-- Comment --> -<!--*< File comment --> -<node name="/SomeNode" xmlns:dx="http://psiamp.org/dtd/doxygen_dbusxml.dtd"> - <!--* test struct outside a namespace and interface --> - <dx:struct name="StructOutsideNamespace"> - <!--* member 1 --> - <dx:member name="member1" type="s"/> - <!--* complex member 1 --> - <dx:member name="complexMember1" type="(ssu)"/> - </dx:struct> - - <!--* Test flag set --> - <dx:flagset name="flagset"> - <!--* Flag 1 of flagset. --> - <dx:value name="FLAG1"/> - </dx:flagset> - - <!--* namespace comment --> - <dx:namespace name="SomeNamespace"> - <!--* struct inside a namespace --> - <dx:struct name="StructInNamespace"> - <!--* member 2 --> - <dx:member name="member2" type="s"/> - </dx:struct> - </dx:namespace> - <!--* Documentation on the interface --> - <interface name="nl.stack.doxygen.test.interface"> - <!--* Test Enum documentation --> - <dx:enum name="TestEnum"> - <!--* key 1 with value 13 --> - <dx:value name="KEY1" value="13"/> - <!--* key 2 without a value --> - <dx:value name="KEY2"/> - </dx:enum> - - <!--* struct inside a interface --> - <dx:struct name="StructInInterface"> - <!--* member 3 --> - <dx:member name="member3" type="s"/> - <!--* Struct in a struct --> - <dx:struct name="StructInAStruct"> - <!--* member4 --> - <dx:member name="member4" type="s"/> - </dx:struct> - <!--* struct member --> - <dx:member name="structMembor" type="(s)" named-type="StructInAStruct"/> - </dx:struct> - <!--* Document method - - Some extended documentation for the method. - - @param[in] input blah. - @param[out] output blub - --> - <method name="method"> - <arg direction="in" name="input" type="(s(s))" named-type="::nl::stack::doxygen::test::interface::StructInInterface"/> - <arg direction="out" type="v" name="output"/> - </method> - - <signal name="signal"> - <!--*< Documentation for signal. - - @param parameter some parameter. - --> - <arg name="parameter" type="s"/> - </signal> - - <!--* property documentation --> - <property name="property" type="s" access="readwrite"/> - - <!--* property documentation read-only --> - <property name="propertyRead" type="s" access="read"/> - <!--* property documentation write-only --> - <property name="propertyWrite" type="s" access="write"/> - </interface> -</node> -</pre> -*/ diff --git a/doc/diagrams.doc b/doc/diagrams.doc index bafb21d..c87337b 100644 --- a/doc/diagrams.doc +++ b/doc/diagrams.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2014 by Dimitri van Heesch. + * Copyright (C) 1997-2015 by Dimitri van Heesch. * * Permission to use, copy, modify, and distribute this software and its * documentation under the terms of the GNU General Public License is hereby @@ -52,10 +52,14 @@ </ul> <li>if \ref cfg_call_graph "CALL_GRAPH" is set to YES, a graphical call graph is drawn for each function showing the - functions that the function directly or indirectly calls. + functions that the function directly or indirectly calls + (see also section \ref cmdcallgraph "\\callgraph" and + section \ref cmdhidecallgraph "\\hidecallgraph"). <li>if \ref cfg_caller_graph "CALLER_GRAPH" is set to YES, a graphical caller graph is drawn for each function showing the - functions that the function is directly or indirectly called by. + functions that the function is directly or indirectly called by + (see also section \ref cmdcallergraph "\\callergraph" and + section \ref cmdhidecallergraph "\\hidecallergraph"). </ul> Using a \ref customize "layout file" you can determine which of the @@ -134,7 +138,7 @@ that doxygen can generate: \verbinclude diagrams_e.h \htmlonly -Click <a href="$(DOXYGEN_DOCDIR)/examples/diagrams/html/index.html">here</a> +Click <a href="examples/diagrams/html/index.html">here</a> for the corresponding HTML documentation that is generated by doxygen<br/> (<code>EXTRACT_ALL</code> = <code>YES</code> is used here). \endhtmlonly diff --git a/doc/docblocks.doc b/doc/docblocks.doc index 333e5d2..f073de5 100644 --- a/doc/docblocks.doc +++ b/doc/docblocks.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2014 by Dimitri van Heesch. + * Copyright (C) 1997-2015 by Dimitri van Heesch. * * Permission to use, copy, modify, and distribute this software and its * documentation under the terms of the GNU General Public License is hereby @@ -259,7 +259,7 @@ located in front of the block instead of after the block. Here is an example of the use of these comment blocks: \include afterdoc.h \htmlonly - Click <a href="$(DOXYGEN_DOCDIR)/examples/afterdoc/html/class_test.html">here</a> + Click <a href="examples/afterdoc/html/class_test.html">here</a> for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly @@ -275,7 +275,7 @@ Here is an example of the use of these comment blocks: Here is an example of a documented piece of C++ code using the Qt style: \include qtstyle.cpp \htmlonly - Click <a href="$(DOXYGEN_DOCDIR)/examples/qtstyle/html/class_test.html">here</a> + Click <a href="examples/qtstyle/html/class_test.html">here</a> for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly @@ -305,7 +305,7 @@ Here is the same piece of code as shown above, this time documented using the JavaDoc style and \ref cfg_javadoc_autobrief "JAVADOC_AUTOBRIEF" set to YES: \include jdstyle.cpp \htmlonly - Click <a href="$(DOXYGEN_DOCDIR)/examples/jdstyle/html/class_test.html">here</a> + Click <a href="examples/jdstyle/html/class_test.html">here</a> for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly @@ -381,7 +381,7 @@ Here is an example of a C header named \c structcmd.h that is documented using structural commands: \include structcmd.h \htmlonly - Click <a href="$(DOXYGEN_DOCDIR)/examples/structcmd/html/structcmd_8h.html">here</a> + Click <a href="examples/structcmd/html/structcmd_8h.html">here</a> for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly @@ -421,7 +421,7 @@ and assume they have to be represented in a preformatted way. \include docstring.py \htmlonly - Click <a href="$(DOXYGEN_DOCDIR)/examples/docstring/html/index.html">here</a> + Click <a href="examples/docstring/html/index.html">here</a> for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly @@ -437,7 +437,7 @@ Here is the same example again but now using doxygen style comments: \include pyexample.py \htmlonly - Click <a href="$(DOXYGEN_DOCDIR)/examples/pyexample/html/index.html">here</a> + Click <a href="examples/pyexample/html/index.html">here</a> for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly @@ -462,7 +462,7 @@ Here is an example VHDL file with doxygen comments: \include mux.vhdl \htmlonly - Click <a href="$(DOXYGEN_DOCDIR)/examples/mux/html/index.html">here</a> + Click <a href="examples/mux/html/index.html">here</a> for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly @@ -571,7 +571,7 @@ Following is an example using doxygen style comments: \include tclexample.tcl \htmlonly - Click <a href="$(DOXYGEN_DOCDIR)/examples/tclexample/html/index.html">here</a> + Click <a href="examples/tclexample/html/index.html">here</a> for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly diff --git a/doc/doxygen.1 b/doc/doxygen.1 index f3a7abc..6861c22 100644 --- a/doc/doxygen.1 +++ b/doc/doxygen.1 @@ -45,6 +45,6 @@ doxygen \fB\-e\fR rtf extensionsFile If \fB\-s\fR is specified the comments in the config file will be omitted. If configName is omitted `Doxyfile' will be used as a default. .SH AUTHOR -Doxygen version VERSION, Copyright Dimitri van Heesch 1997-2014 +Doxygen version VERSION, Copyright Dimitri van Heesch 1997-2015 .SH SEE ALSO doxywizard(1). diff --git a/doc/doxygen_manual.tex b/doc/doxygen_manual.tex index 4bac9a9..c97c5f0 100644 --- a/doc/doxygen_manual.tex +++ b/doc/doxygen_manual.tex @@ -1,7 +1,7 @@ % % % -% Copyright (C) 1997-2014 by Dimitri van Heesch. +% Copyright (C) 1997-2015 by Dimitri van Heesch. % % Permission to use, copy, modify, and distribute this software and its % documentation under the terms of the GNU General Public License is hereby diff --git a/doc/doxygen_usage.doc b/doc/doxygen_usage.doc index d84432e..bcb14e8 100644 --- a/doc/doxygen_usage.doc +++ b/doc/doxygen_usage.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2014 by Dimitri van Heesch. + * Copyright (C) 1997-2015 by Dimitri van Heesch. * * Permission to use, copy, modify, and distribute this software and its * documentation under the terms of the GNU General Public License is hereby diff --git a/doc/doxywizard_usage.doc b/doc/doxywizard_usage.doc index bec143c..310c358 100644 --- a/doc/doxywizard_usage.doc +++ b/doc/doxywizard_usage.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2014 by Dimitri van Heesch. + * Copyright (C) 1997-2015 by Dimitri van Heesch. * * Permission to use, copy, modify, and distribute this software and its * documentation under the terms of the GNU General Public License is hereby diff --git a/doc/external.doc b/doc/external.doc index be7d764..c3ec811 100644 --- a/doc/external.doc +++ b/doc/external.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2014 by Dimitri van Heesch. + * Copyright (C) 1997-2015 by Dimitri van Heesch. * * Permission to use, copy, modify, and distribute this software and its * documentation under the terms of the GNU General Public License is hereby diff --git a/doc/extsearch.doc b/doc/extsearch.doc index e07edd7..6429766 100644 --- a/doc/extsearch.doc +++ b/doc/extsearch.doc @@ -1,6 +1,6 @@ /****************************************************************************** * - * Copyright (C) 1997-2014 by Dimitri van Heesch. + * Copyright (C) 1997-2015 by Dimitri van Heesch. * * Permission to use, copy, modify, and distribute this software and its * documentation under the terms of the GNU General Public License is hereby diff --git a/doc/faq.doc b/doc/faq.doc index 356c42b..bd327a1 100644 --- a/doc/faq.doc +++ b/doc/faq.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2014 by Dimitri van Heesch. + * Copyright (C) 1997-2015 by Dimitri van Heesch. * * Permission to use, copy, modify, and distribute this software and its * documentation under the terms of the GNU General Public License is hereby @@ -63,7 +63,7 @@ PREDEFINED = MY_MACRO()= manual for more information. </ol> -\section faq_extract_allWhen I set EXTRACT_ALL to NO none of my functions are shown in the documentation. +\section faq_extract_all When I set EXTRACT_ALL to NO none of my functions are shown in the documentation. In order for global functions, variables, enums, typedefs, and defines to be documented you should document the file in which these commands are @@ -77,6 +77,19 @@ block containing the \ref cmddefgroup "\\defgroup" command. For member functions or functions that are part of a namespace you should document either the class or namespace. +\section faq_ext_mapping My file with a custom extension is not parsed (properly) (anymore). + +Doxygen only parses files that are specified as input (via the \ref cfg_input "INPUT" tag) +and that match a specified extension (mentioned in \ref cfg_file_patterns "FILE_PATTERNS") +The list of files is then reduced by excluding files listed as \ref cfg_exclude "EXCLUDE" or +files that match the patterns set by \ref cfg_exclude_patterns "EXCLUDE_PATTERNS". + +In the past doxygen parsed all files with an unknown extension as C files which could lead to +undesired results. Since version 1.8.8, doxygen requires that you specify a mapping that tells +for a certain file extension, which parser to use. +This mapping is specified using the \ref cfg_extension_mapping "EXTENSION_MAPPING" tag. +If no mapping is specified the file's contents will be ignored. + \section faq_code How can I make doxygen ignore some code fragment? The new and easiest way is to add one comment block diff --git a/doc/features.doc b/doc/features.doc index bd548c2..dd75a9d 100644 --- a/doc/features.doc +++ b/doc/features.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2014 by Dimitri van Heesch. + * Copyright (C) 1997-2015 by Dimitri van Heesch. * * Permission to use, copy, modify, and distribute this software and its * documentation under the terms of the GNU General Public License is hereby diff --git a/doc/formulas.doc b/doc/formulas.doc index 1a6208e..937ff86 100644 --- a/doc/formulas.doc +++ b/doc/formulas.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2014 by Dimitri van Heesch. + * Copyright (C) 1997-2015 by Dimitri van Heesch. * * Permission to use, copy, modify, and distribute this software and its * documentation under the terms of the GNU General Public License is hereby diff --git a/doc/grouping.doc b/doc/grouping.doc index 4397b76..2e11e7e 100644 --- a/doc/grouping.doc +++ b/doc/grouping.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2014 by Dimitri van Heesch. + * Copyright (C) 1997-2015 by Dimitri van Heesch. * * Permission to use, copy, modify, and distribute this software and its * documentation under the terms of the GNU General Public License is hereby diff --git a/doc/htmlcmds.doc b/doc/htmlcmds.doc index d041f1e..b8324f8 100644 --- a/doc/htmlcmds.doc +++ b/doc/htmlcmds.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2014 by Dimitri van Heesch. + * Copyright (C) 1997-2015 by Dimitri van Heesch. * * Permission to use, copy, modify, and distribute this software and its * documentation under the terms of the GNU General Public License is hereby diff --git a/doc/index.doc b/doc/index.doc index 0cb1e59..8b0d403 100644 --- a/doc/index.doc +++ b/doc/index.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2014 by Dimitri van Heesch. + * Copyright (C) 1997-2015 by Dimitri van Heesch. * * Permission to use, copy, modify, and distribute this software and its * documentation under the terms of the GNU General Public License is hereby @@ -118,7 +118,7 @@ The third part provides information for developers: \addindex license \addindex GPL -Copyright © 1997-2014 by +Copyright © 1997-2015 by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>.<p> Permission to use, copy, modify, and distribute this software and its diff --git a/doc/install.doc b/doc/install.doc index 9648ade..295154f 100644 --- a/doc/install.doc +++ b/doc/install.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2014 by Dimitri van Heesch. + * Copyright (C) 1997-2015 by Dimitri van Heesch. * * Permission to use, copy, modify, and distribute this software and its * documentation under the terms of the GNU General Public License is hereby @@ -35,11 +35,10 @@ following to build the executable: \addindex libiconv \addindex make \addindex strip + \addindex python <li>In order to generate a \c Makefile for your platform, you need - <a href="http://www.perl.com/">perl</a> - \addindex perl -<li>The configure script assume the availability of standard UNIX tools such - as <code>sed, date, find, uname, mv, cp, cat, echo, tr, cd</code> and \c rm. + <a href="http://www.cmake.org/">cmake</a> version 2.8.12 or later. + \addindex cmake </ul> To take full advantage of doxygen's features the following additional @@ -49,7 +48,7 @@ tools should be installed. <li>Qt Software's GUI toolkit <a href="http://qt-project.org/">Qt</A> \addindex Qt - version 4.3 or higher (but currently, Qt 5.x is not supported). + version 4.3 or higher (but currently, Qt 5.x is not yet supported). This is needed to build the GUI front-end doxywizard. <li>A \LaTeX distribution: for instance <a href="http://www.tug.org/interest.html#free">TeX Live</a> @@ -61,11 +60,10 @@ tools should be installed. If you compile graphviz yourself, make sure you do include freetype support (which requires the freetype library and header files), otherwise the graphs will not render proper text labels. -<li>For formulas or if you do not wish to use `pdflatex, the ghostscript interpreter - is needed. You can find it at +<li>For formulas in the HTML output (when MathJax is not used) + or in case you do not wish to use `pdflatex, + the ghostscript interpreter is needed. You can find it at <a href="http://www.ghostscript.com/">www.ghostscript.com</a>. -<li>In order to generate doxygen's own documentation, Python is needed, you - can find it at <a href="http://www.python.org">www.python.org</a>. </ul> Compilation is now done by performing the following steps: @@ -76,62 +74,46 @@ Compilation is now done by performing the following steps: gunzip doxygen-$VERSION.src.tar.gz # uncompress the archive tar xf doxygen-$VERSION.src.tar # unpack it -<li>Run the configure script: - - sh ./configure +<li>Create a build directory (for instance inside the source tree) - The script tries to determine the platform you use, the make tool - (which \e must be GNU make) and the perl - interpreter. It will report what it finds. + cd doxygen-$VERSION + mkdir build - To override the auto detected platform and compiler you can run - configure as follows: +<li>Run cmake with the makefile generator - configure --platform platform-type + cmake -G "Unix Makefiles" .. - See the <code>PLATFORMS</code> file for a list of possible platform - options. + <code>cmake</code> tries to determine the platform you use, and will look + for the requires tools. It will report if something is missing. - If you have Qt-4.3 or higher installed and want to build the GUI - front-end, you should run the configure script with - the `--with-doxywizard` option: + If you have Qt-4.3 or higher installed and want to build the GUI + front-end, you should enable it as follows: - configure --with-doxywizard + cmake -Dbuild_wizard=YES For an overview of other configuration options use - configure --help + cmake -L <li>Compile the program by running make: make - The program should compile without problems and the binaries - (<code>doxygen</code> and optionally <code>doxywizard</code>) - should be available in the bin directory of the distribution. + The program should compile without problems and the binaries + (<code>doxygen</code> and optionally <code>doxywizard</code>) + should be available in the bin directory within the build directory. <li>Optional: Generate the user manual. + cmake -Dbuild_doc=YES make docs - To let doxygen generate the HTML documentation. + To let doxygen generate the HTML and PDF documentation. - The HTML directory of the distribution will now contain the html - documentation (just point a HTML browser to the file - <code>index.html</code> in the - html directory). You will need the <code>python</code> interpreter - for this. + The HTML directory within the build directory will now contain the html + documentation (just point a HTML browser to the file + <code>index.html</code> in the html directory). -<li>Optional: Generate a PDF version of the manual - (you will need <code>pdflatex</code>, <code>makeindex</code>, and - <code>egrep</code> for this). - - make pdf - - The PDF manual <code>doxygen_manual.pdf</code> will be located - in the latex directory of the distribution. Just - view and print it via the acrobat reader. - </ol> \section install_bin_unix Installing the binaries on UNIX @@ -164,107 +146,15 @@ the wrong directory! If you have a RPM or DEP package, then please follow the standard installation procedure that is required for these packages. -\section unix_problems Known compilation problems for UNIX - -<b>Qt problems</b> - -The Qt include files and libraries are not a subdirectory of the -directory pointed to by <code>QTDIR</code> on some systems -(for instance on Red Hat 6.0 includes are in <code>/usr/include/qt</code> and -libs are in <code>/usr/lib</code>). - -The solution: go to the root of the doxygen distribution and do: - - mkdir qt - cd qt - ln -s your-qt-include-dir-here include - ln -s your-qt-lib-dir-here lib - ln -s your-qt-bin-dir-here bin - export QTDIR=$PWD - -If you have a <code>csh</code>-like shell you should use <code>setenv QTDIR \$PWD</code> -instead of the <code>export</code> command above. - -Now install doxygen as described above. - -<b>Bison problems</b> - -Versions 1.31 to 1.34 of \c bison contain a "bug" that results in a -compiler errors like this: - -<code>ce_parse.cpp:348: member `class CPPValue yyalloc::yyvs' with </code> -constructor not allowed in union - -This problem has been solved in version 1.35 (versions before 1.31 -will also work). - -<b>Sun compiler problems</b> - -It appears that doxygen doesn't work properly if it is compiled -with Sun's C++ WorkShop Compiler. I cannot verify this myself as I do -not have access to a Solaris machine with this compiler. With GNU compiler -it does work and installing Sun patch 111679-13 has also been reported -as a way to fix the problem. - -when configuring with `--static` I got: - -\verbatim -Undefined first referenced - symbol in file -dlclose /usr/lib/libc.a(nss_deffinder.o) -dlsym /usr/lib/libc.a(nss_deffinder.o) -dlopen /usr/lib/libc.a(nss_deffinder.o) -\endverbatim - -Manually adding `-Bdynamic` after the target rule in -`Makefile.doxygen` will fix this: - - $(TARGET): $(OBJECTS) $(OBJMOC) - $(LINK) $(LFLAGS) -o $(TARGET) $(OBJECTS) $(OBJMOC) $(LIBS) -Bdynamic - -<b>GCC compiler problems</b> - -Older versions of the GNU compiler have problems with constant strings -containing characters with character codes larger than 127. Therefore -the compiler will fail to compile some of the `translator_xx.h` files. -A workaround, if you are planning to use the English translation only, -is to configure doxygen with the `--english-only` option. - -On some platforms (such as OpenBSD) using some versions of gcc with --O2 can lead to eating all memory during the compilation of files -such as config.cpp. As a workaround use `--debug` as a configure option -or omit the `-O2` for the particular files in the Makefile. - -Gcc versions before 2.95 may produce broken binaries due to bugs in -these compilers. - -<b>Dot problems</b> - -Due to a change in the way image maps are generated, older versions -of doxygen (\<=1.2.17) will not work correctly with newer versions of -graphviz (\>=1.8.8). The effect of this incompatibility is that -generated graphs in HTML are not properly clickable. For doxygen 1.3 -it is recommended to use at least graphviz 1.8.10 or higher. -For doxygen 1.4.7 or higher it is recommended to -use GraphViz 2.8 or higher to avoid font issues. +\section install_src_windows Compiling from source on Windows -<b>Red Hat 9.0 problems</b> +From version 1.8.10 onwards, build files need to be generated by cmake. +cmake can be downloaded from http://www.cmake.org/download/ -If you get the following error after running make -\verbatim -tmake error: qtools.pro:70: Syntax error -\endverbatim -then first type -\verbatim -export LANG= -\endverbatim -before running make. - -\section install_src_windows Compiling from source on Windows +At the moment only the express version of Visual Studio 2013 is tested, +but other version might also work. -From version 1.7.0 onwards, build files are provided for Visual Studio 2008. -Also the free (as in beer) "Express" version of Developer Studio can be used to -compile doxygen. Alternatively, you can compile doxygen +Alternatively, you can compile doxygen \ref install_src_unix "the UNIX way" using <a href="http://en.wikipedia.org/wiki/Cygwin">Cygwin</a> or <a href="http://www.mingw.org/">MinGW</a>. @@ -273,13 +163,11 @@ The next step is to install modern versions of \c bison and \c flex (see http://sourceforge.net/projects/winflexbison. After installation and adding them to your `path` rename `win_flex.exe` to `flex.exe` and `win_bison.exe` to `bison.exe`) Furthermore you have to install \c python (version 2.6 or higher, see http://www.python.org). -These packages are needed during the -compilation process if you use a GitHub snapshot of doxygen (the official source releases -come with pre-generated sources). +These packages are needed during the compilation process. Download doxygen's source tarball and put it somewhere (e.g. use <code>c:\\tools</code>) -Now start a new command shell and type +Now start a visual studio native command shell (for either x86 or x64) and type \verbatim cd c:\tools tar zxvf doxygen-x.y.z.src.tar.gz @@ -288,12 +176,14 @@ to unpack the sources (you can obtain \c tar from e.g. http://gnuwin32.sourcefor Alternatively you can use an unpack program, like 7-Zip (see http://www.7-zip.org) or use the build in unpack feature of modern Windows systems). -Now your environment is setup to build \c doxygen. +Now your environment is setup to generate the required project files for \c doxygen. -Inside the \c doxygen-x.y.z directory you will find a \c winbuild directory -containing a \c Doxygen.sln file. Open this file in Visual Studio. -You can now build the Release or Debug flavor of Doxygen by right-clicking -the project in the solutions explorer, and selecting Build. +cd into the \c doxygen-x.y.z directory, create and cd to a build directory +\verbatim +mkdir build +cd build +cmake -G "Visual Studio 12 2013" +\endverbatim Note that compiling Doxywizard currently requires Qt version 4 (see http://qt-project.org/). @@ -301,149 +191,6 @@ Note that compiling Doxywizard currently requires Qt version 4 Also read the next section for additional tools you may need to install to run doxygen with certain features enabled. -<!-- - -Currently, I have only compiled doxygen for Windows using Microsoft's -Visual C++ (). For other compilers you may need to edit the -perl script in <code>wintools/make.pl</code> a bit. -Let me know what you had to change if you got Doxygen working with another -compiler. If you have Visual Studio you can also use the .dsw file found in -the <code>wintools</code> directory. Note that this file is not maintained -by me, so it might be outdated a little. - -If you have Visual C++ 6.0, and the source distribution, you can easily -build doxygen using the project files in the \c wintools directory. If -you want to build the CVS sources, or want to build from the command line, -or with another compiler, you have to follow the steps below. - -Thomas Baust reported that if you have Visual Studio.NET (2003) then -you should be aware that there is a problem with the _popen() and _pclose() -implementation, which currently leaks handles, so if you build doxygen with -it and use the INPUT_FILTER, you will run to risk of crashing Windows! -The problem is reported to and confirmed by Microsoft so maybe it will -fixed in the next service pack. - -Since Windows comes without all the nice tools that UNIX users are -used to, you'll need to install a number of these tools before you can compile -doxygen for Windows from the command-line. - -Here is what is required: -<ul> -<li>An unzip/untar tool like WinZip to unpack the tar source distribution. - This can be found at http://www.winzip.com/ - - The good, tested, and free alternative is the <code>tar</code> utility - supplied with <a href="http://sourceware.cygnus.com/cygwin/">cygwin - tools</a>. Anyway, the Cygwin's \c flex, \c bison, and \c sed are also - recommended below. - -<li>Microsoft Visual C++ (I only tested with version 6.0). - Use the <code>vcvars32.bat</code> batch file to set the environment - variables (if you did not select to do this automatically during - installation). - - Borland C++ or MINGW (see http://www.mingw.org/) are also supported. - -<li>Perl 5.0 or higher for Windows. This can be downloaded from: - http://www.ActiveState.com/Products/ActivePerl/ - -<li>The GNU tools \c flex, \c bison, and \c sed. - To get these working on Windows you should install the - <a href="http://sources.redhat.com/cygwin/">cygwin tools</a> - - Alternatively, you can also choose to - download only a <a href="http://www.doxygen.org/dl/cygwin_tools.zip">small subset</a> - of the cygwin tools that I put together just to compile doxygen. - - As a third alternative one could use the GNUWin32 tools that can be - found at http://gnuwin32.sourceforge.net/ - - Make sure the <code>BISON_SIMPLE</code> environment variable points to the - location where the files <code>bison.simple</code> and - is located. For instance if these file is in - <code>c:\\tools\\cygwin\\usr\\share</code> then BISON_SIMPLE should - be set to <code>c:/tools/cygwin/usr/share/bison.simple</code> - - Also make sure the tools are available from a dos box, by adding - the directory they are in to the search path. - - For those of you who are very new to cygwin (if you are going to - install it from scratch), you should notice that there is an - archive file <code>bootstrap.zip</code> which also contains the - <code>tar</code> utility (<code>tar.exe</code>), <code>gzip</code> - utilities, and the <code>cygwin1.dll</code> core. This also means - that you have the <code>tar</code> in hands from the start. It - can be used to unpack the tar source distribution instead of - using WinZip -- as mentioned at the beginning of this list of - steps. - -<li>From Doxygen-1.2.2-20001015 onwards, the distribution includes the part - of Qt that is needed for to compile doxygen. - The Windows specific part were also created. - As a result doxygen (without the wizard) can be compiled on systems - without X11 or (the commercial version of) Qt. - -<li>If you used WinZip to extract the tar archive it will (apparently) not - create empty folders, so you have to add the folders - <code>objects</code> and <code>bin</code> manually in the root of the - distribution before compiling. - -</ul> - - -Compilation is now done by performing the following steps: - -<ol> -<li>Open a dos box. - Make sure all tools (i.e. <code>nmake</code>, <code>latex</code>, - <code>gswin32</code>, <code>dvips</code>, <code>sed</code>, - <code>flex</code>, <code>bison</code>, <code>cl</code>, - <code>rm</code>, and <code>perl</code>), are accessible from - the command-line (add them to the PATH environment variable if - needed). - - Notice: The use of \LaTeX is optional and only needed for compilation - of the documentation into PostScript or PDF. - It is \e not needed for compiling the doxygen's binaries. - -<li>Go to the doxygen root dir and type: - -\verbatim - make.bat msvc -\endverbatim - - This should build the executable - <code>doxygen.exe</code> using Microsoft's Visual C++ compiler - (The compiler should not produce any serious warnings or errors). - - You can use also the <code>bcc</code> argument to build - executables using the Borland C++ compiler, or - <code>mingw</code> argument to compile using GNU gcc. - -<li>To build the examples, go to the <code>examples</code> subdirectory - and type: - -\verbatim - nmake -\endverbatim - -<li>To generate the doxygen documentation, go to the <code>doc</code> - subdirectory and type: - -\verbatim - nmake -\endverbatim - - The generated HTML docs are located in the <code>..\\html</code> - subdirectory. - - The sources for \LaTeX documentation are located in the <code>..\\latex</code> - subdirectory. From those sources, the DVI, PostScript, and PDF - documentation can be generated. -</ol> - ---> - \section install_bin_windows Installing the binaries on Windows Doxygen comes as a self-installing archive, so installation is extremely simple. @@ -481,85 +228,6 @@ latex.exe, pdflatex.exe, and gswin32c.exe are present in the search path of a command box. Follow <a href="http://www.computerhope.com/issues/ch000549.htm">these</a> instructions if you are unsure and run the commands from a command box to verify it works. -<!-- -There is no fancy installation procedure at the moment (if anyone can -add it in a location independent way please let me know). - -To install doxygen, just copy the binaries from the <code>bin</code> directory -to a location somewhere in the path. Alternatively, you can include -the <code>bin</code> directory of the distribution to the path. - -There are a couple of tools you may want to install to use all of doxygen's -features: - -<ul> -<li>To generate \LaTeX documentation or formulas in HTML you need the tools: - <code>latex</code>, <code>dvips</code> and <code>gswin32</code>. - To get these working under Windows - install the fpTeX distribution. You can find more info at: - http://www.fptex.org/ and download it from CTAN or one of its mirrors. - In the Netherlands for example this would be: - ftp://ftp.easynet.nl/mirror/CTAN/systems/win32/fptex/ - - Make sure the tools are available from a dos box, by adding the - directory they are in to the search path. - - For your information, \LaTeX is a freely available set of so - called macros and styles on the top of the famous \TeX program - (by famous Donald Knuth) and the accompanied utilities (all - available for free). It is used for high quality - typesetting. The result -- in the form of so called - <code>DVI</code> (DeVice Independent) file -- can be printed or - displayed on various devices preserving exactly the same look up - to the capability of the device. The <code>dvips</code> allows you - to convert the <code>dvi</code> to the high quality PostScript - (i.e. PostScript that can be processed by utilities like - <code>psnup</code>, <code>psbook</code>, <code>psselect</code>, - and others). The derived version of \TeX (the pdfTeX) can be used - to produce PDF output instead of DVI, or the PDF can be produced - from PostScript using the utility <code>ps2pdf</code>. - - If you want to use MikTeX then you need to select at least the - medium size installation. For really old versions of MikTex or minimal - installations, you may need to download the fancyhdr package separately. - You can find it in the - <a href="ftp://ftp.tex.ac.uk/tex-archive/macros/latex/contrib/supported/fancyhdr/"> - contrib/supported</a> directory of the tex archives. - -<li>If you want to generate compressed HTML help - (see \ref cfg_generate_htmlhelp "GENERATE_HTMLHELP") in the - config file, then you need the Microsoft HTML help workshop. - You can download it from - <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/htmlhelp/html/vsconHH1Start.asp">Microsoft</a>. - -<li>If you want to produce Qt Compressed Help files (see \ref - cfg_qhelgenerator_loc "QHG_LOCATION") in the config file, - then you need qhelpgenerator which is part of Qt. - You can download Qt from - <a href="http://qt-project.org/downloads">Qt Software Downloads</a>. - -<li><a href="http://www.graphviz.org/"> - the Graph visualization toolkit version 1.8.10</a><br> - Needed for the include dependency graphs, the graphical inheritance graphs, - and the collaboration graphs. -</ul> - ---> - -\section build_tools Tools used to develop doxygen - -Doxygen was developed and tested under Linux & MacOSX using the following -open-source tools: -<ul> -<li>GCC version 4.6.3 (Linux) and 4.2.1 (MacOSX) -<li>GNU flex version 2.5.35 -<li>GNU bison version 2.5 (Linux) and 2.3 (MacOSX) -<li>GNU make version 3.81 -<li>Perl version 5.12 -<li>Python version 2.7 and 3.4 -<li>TeX Live 2009 (or later) -</ul> - \htmlonly Go to the <a href="starting.html">next</a> section or return to the <a href="index.html">index</a>. diff --git a/doc/language.tpl b/doc/language.tpl index 78e3e97..01d906b 100644 --- a/doc/language.tpl +++ b/doc/language.tpl @@ -5,7 +5,7 @@ change the language.doc, make the changes here and inside maintainers.txt. /****************************************************************************** * %(editnote)s * - * Copyright (C) 1997-2014 by Dimitri van Heesch. + * Copyright (C) 1997-2015 by Dimitri van Heesch. * * Permission to use, copy, modify, and distribute this software and its * documentation under the terms of the GNU General Public License is hereby diff --git a/doc/markdown.doc b/doc/markdown.doc index e97b29e..87af3d8 100644 --- a/doc/markdown.doc +++ b/doc/markdown.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2014 by Dimitri van Heesch. + * Copyright (C) 1997-2015 by Dimitri van Heesch. * * Permission to use, copy, modify, and distribute this software and its * documentation under the terms of the GNU General Public License is hereby @@ -390,6 +390,12 @@ int func(int a,int b) { return a*b; } The curly braces and dot are optional by the way. +Another way to denote fenced code blocks is to use 3 or more backticks (```): + + ``` + also a fenced code block + ``` + \subsection md_header_id Header Id Attributes Standard Markdown has no support for labeling headers, which diff --git a/doc/output.doc b/doc/output.doc index 2cb81bd..3a24a60 100644 --- a/doc/output.doc +++ b/doc/output.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2014 by Dimitri van Heesch. + * Copyright (C) 1997-2015 by Dimitri van Heesch. * * Permission to use, copy, modify, and distribute this software and its * documentation under the terms of the GNU General Public License is hereby diff --git a/doc/preprocessing.doc b/doc/preprocessing.doc index 0ba9b12..d62bbb3 100644 --- a/doc/preprocessing.doc +++ b/doc/preprocessing.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2014 by Dimitri van Heesch. + * Copyright (C) 1997-2015 by Dimitri van Heesch. * * Permission to use, copy, modify, and distribute this software and its * documentation under the terms of the GNU General Public License is hereby diff --git a/doc/searching.doc b/doc/searching.doc index 25dcc3a..dcf858f 100644 --- a/doc/searching.doc +++ b/doc/searching.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2014 by Dimitri van Heesch. + * Copyright (C) 1997-2015 by Dimitri van Heesch. * * Permission to use, copy, modify, and distribute this software and its * documentation under the terms of the GNU General Public License is hereby diff --git a/doc/starting.doc b/doc/starting.doc index a465d3f..081ef8b 100644 --- a/doc/starting.doc +++ b/doc/starting.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2014 by Dimitri van Heesch. + * Copyright (C) 1997-2015 by Dimitri van Heesch. * * Permission to use, copy, modify, and distribute this software and its * documentation under the terms of the GNU General Public License is hereby diff --git a/doc/translator.py b/doc/translator.py index 19277be..69e7de8 100644 --- a/doc/translator.py +++ b/doc/translator.py @@ -1796,7 +1796,9 @@ class TrManager: # document template.
tplDic = {}
- s = 'Do not edit this file. It was generated by the %s script. * Instead edit %s and %s' % (self.script_name, self.languageTplFileName, self.maintainersFileName)
+ s = ('Do not edit this file. It was generated by the %s script.\n' +\
+ ' * Edit the %s and %s files instead.') % (
+ self.script_name, self.languageTplFileName, self.maintainersFileName)
tplDic['editnote'] = s
tplDic['doxVersion'] = self.doxVersion
@@ -1987,17 +1989,14 @@ if __name__ == '__main__': # The Python 2.6+ or 3.3+ is required.
major, minor, patch = (int(e) for e in platform.python_version_tuple())
- print(major, minor, patch)
if (major == 2 and minor < 6) or (major == 3 and minor < 0):
print('Python 2.6+ or Python 3.0+ are required for the script')
sys.exit(1)
- # The translator manager builds the transl objects, parses the related
+ # The translator manager builds the Transl objects, parses the related
# sources, and keeps them in memory.
trMan = TrManager()
- # Generate the language.doc.
+ # Process the Transl objects and generate the output files.
trMan.generateLanguageDoc()
-
- # Generate the translator report.
trMan.generateTranslatorReport()
diff --git a/doc/trouble.doc b/doc/trouble.doc index d36e330..47ef623 100644 --- a/doc/trouble.doc +++ b/doc/trouble.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2014 by Dimitri van Heesch. + * Copyright (C) 1997-2015 by Dimitri van Heesch. * * Permission to use, copy, modify, and distribute this software and its * documentation under the terms of the GNU General Public License is hereby @@ -18,8 +18,6 @@ \section knowproblems Known Problems <ul> -<li>If you have problems building doxygen from sources, please - read \ref unix_problems "this section" first. <li>Doxygen is <em>not</em> a real compiler, it is only a lexical scanner. This means that it can and will not detect errors in your source code. <li>Doxygen has a build in preprocessor, but this works slightly different than diff --git a/doc/xmlcmds.doc b/doc/xmlcmds.doc index 0e8aa64..501bf91 100644 --- a/doc/xmlcmds.doc +++ b/doc/xmlcmds.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2014 by Dimitri van Heesch. + * Copyright (C) 1997-2015 by Dimitri van Heesch. * * Permission to use, copy, modify, and distribute this software and its * documentation under the terms of the GNU General Public License is hereby |