From 770adb37b2072bbea5412f9cc2058d98d1de60e4 Mon Sep 17 00:00:00 2001 From: Jakub Wilk Date: Tue, 2 Feb 2016 20:17:21 +0100 Subject: Fix documentation typos --- doc/changelog.doc | 81 ++++++++++++++++++++++++++--------------------------- doc/commands.doc | 2 +- doc/docblocks.doc | 2 +- doc/extsearch.doc | 2 +- doc/maintainers.txt | 4 +-- doc/translator.py | 20 ++++++------- 6 files changed, 55 insertions(+), 56 deletions(-) diff --git a/doc/changelog.doc b/doc/changelog.doc index 31e9a49..3d7846d 100644 --- a/doc/changelog.doc +++ b/doc/changelog.doc @@ -136,7 +136,7 @@
  • Tweaked the htmlonly sections in the manual so it produces valid HTML output [view]
  • Undo _doxygen to libdoxygen target change [view]
  • Updated instructions to toggle debugging flex code [view]
    • -
  • Updated italian translation and translator email address [view]
    • +
  • Updated Italian translation and translator email address [view]
  • Updated the Greek translation [view]
  • Use CPack to generate rpm/deb packages [view]
  • Use STATIC libraries to prevent them being shared [view]
    • @@ -230,7 +230,7 @@
  • Documenting RESULT variable of Fortran FUNCTION [view], [view]
  • Doxygen LaTeX / PDF links point to page 1 [view]
  • Enable relative paths referenced source files [view]
    • -
  • Escape "@" in names as it is not allowed in XML / Docbook names (comming from anon namespaces) [view]
    • +
  • Escape "@" in names as it is not allowed in XML / Docbook names (coming from anon namespaces) [view]
  • Fix for bug 746673. [view]
  • Fix for building diagram example conditionally [view]
  • Fix for issue 744670 [view]
    • @@ -430,7 +430,7 @@
  • fix incomplete TOC : no Classe etc.
  • add brief description for Functions etc.
  • Comply with REPEAT_BRIEF
    • -
  • Do not output duplicated contents when detailed descripton is missing.
    • +
  • Do not output duplicated contents when detailed description is missing.
  • set table colwidth for Param/RetVal
    • @@ -678,7 +678,7 @@
  • Bug 721169 - Wrong call graph in simple situation [view]
  • Bug 721302 - [Latex/PDF] Merging brief and detailed description in file section [view]
  • Bug 721462 - Parsing problem with C++11 empty initializer lists [view]
    • -
  • Bug 721618 - Move contructors and move assignment operators of embedded classes of template classes cannot be matched. [view]
    • +
  • Bug 721618 - Move constructors and move assignment operators of embedded classes of template classes cannot be matched. [view]
  • Bug 721878 - Dia diagrams not displayed by Firefox [view]
  • Bug 722457 - regression referencing namespaced type [view]
  • Bug 722603 - doxygen nested \if \endif sample not working [view]
    • @@ -767,7 +767,7 @@
  • List only the project pages in "Related Pages" [view]
  • Made documentation more consistent [view]
  • Make sure all ids in g_linkRefs are lower case [view]
    • -
  • Make the MAN_SUBDIR setting overide the name of the directry the man pages are placed in. [view]
    • +
  • Make the MAN_SUBDIR setting override the name of the directory the man pages are placed in. [view]
  • Meta tag in the HTML search page was not closed properly [view]
  • Minor fixes for the new build locations [view]
  • Missing & and chars after " in tree of chm documentation [view]
    • @@ -783,7 +783,7 @@
  • Removed generated file src/settings.h from source repository [view]
  • Removed message, minor restructuring [view]
  • Removed remark about installdox from the FAQ [view]
    • -
  • Restructered html entity handling [view]
    • +
  • Restructured html entity handling [view]
  • Reverted #132 after submitter reported that it did not work [view]
  • Showing error message on windows in case on error on startup [view]
  • Simplified LaTeX header/footer escaping [view]
    • @@ -895,7 +895,7 @@
  • Bug 719639 - @xrefitem with empty heading string
  • Bug 720046 - Document inline objective-C blocks
  • Bug 720092 - USE_MDFILE_AS_MAINPAGE doesn't work if full path is specified.
    • -
  • Bug 720580 - inline source browser shows wrong code with muilti-line c++11's raw strings
    • +
  • Bug 720580 - inline source browser shows wrong code with multi-line c++11's raw strings
  • Add support for honoring svg image format preference in msc
  • Added @parblock and @endparblock commands
  • Added compile support for Mavericks
    • @@ -907,18 +907,18 @@
  • Added rudimentary support for Django like template system for output creation.
  • Added the possibility to specify the -d option in the Visual studio GUI on windows for the lex rules
  • Adjust internationalization part to current situation
    • -
  • Alignment of @code and @verbatim section When having a code and a verbatim section the boxes are not alligned, this patch fixes this. Example code, aa.c; standard Doxyfile: /** \file
    • +
  • Alignment of @code and @verbatim section When having a code and a verbatim section the boxes are not aligned, this patch fixes this. Example code, aa.c; standard Doxyfile: /** \file
  • Allow @ref to unlabeled markdown page by name, i.e. @ref mypage.md
  • Allow links to other markdown pages of the form [link text](page.md)
  • Avoid accessing uninitialized memory in fileToString
    • -
  • Build problem with unistd.h and Cygwin The standard g++ compiler under windows (win32-g++) has unistd.gh file; Microsoft windows does not have it, therfore it is better to use the winbuild directory in case of windows adn no dependency otherwise
    • +
  • Build problem with unistd.h and Cygwin The standard g++ compiler under windows (win32-g++) has unistd.gh file; Microsoft windows does not have it, therefore it is better to use the winbuild directory in case of windows and no dependency otherwise
  • Consistency in language part of the documentation Made documentation more inline with other parts of the documentation (regarding the way e.g. filenames are presented) Corrected some spelling errors Corrected the warning in the language.doc by placing ta reference to the files from which language.doc is generated Corrected the color for the languages that are still v1.4.6 (language name now also red in stead of a pink background, was confusing with languages that were 1.5 / 1.6 compatible)
  • Corrected some inconsistencies in the comments
  • Debug output for lexical analyzer
  • Deleted generated files from source repository
  • Doxygen didn't allow @ref to parameters of type reference to an array.
  • Doxysearch under Cygwin should not have extension cgi.exe but just .cgi
    • -
  • Esperanto not supported by htmlhelp compiler reverting for esperanto to default language (US English)
    • +
  • Esperanto not supported by htmlhelp compiler reverting for Esperanto to default language (US English)
  • Fixed a number of compiler warnings reported by newer clang compiler
  • Fixed compilation issues in doxyapp
  • Fixed compile warning
    • @@ -938,17 +938,16 @@
  • More fixes for the Windows build
  • Patch regarding generating the rules file for the windows build regarding languages, some inconsistencies in the (windows) build system, corrections to some spelling.
  • Regenerated language.doc
    • -
  • Removed japanese characters in maintainers.txt as they break the build
    • +
  • Removed Japanese characters in maintainers.txt as they break the build
  • Removed redundant backslashes in regexp pattern
  • Report details about fork() failure in logs.
  • Russian translator updated, new Russian maintainer added.
  • Small spelling correction to generate an rtf extensions file -> to generate a rtf extensions file
  • Some texts can be independent of \htmlonly / \latexonly
  • Space missing in error message. the word 'in' and the vale of filesOption were concatenated
    • -
  • This patch contains changes regarding the build system so that the *nix and Windows systems use the same information (consistency). Some use names routine names have been changed (from .l files with -P option) to reflect the file name that generated the routines, this makes it easier to create a general procedure. A number of include / header files are files are generated from different file types (html, xml, js), due some limitations of the windows build system the generated file names had to be changed (the extension in the windows build system is only available including the '.' so e.g. the file jquery_fx.js generates now jquery_fx.js.h instead of jquery_fx_js.h) In the windows version the creation of .cpp files from .l files has been adjusted to correct for the YY_BUF_SIZE problems. Furthermore on windows (and also used on *nix) some commends have been replaced with python scripts so that on windows only python is need (besides flex and and bison). On *nix also perl is required for the generation using tmake.
    • +
  • This patch contains changes regarding the build system so that the *nix and Windows systems use the same information (consistency). Some use names routine names have been changed (from .l files with -P option) to reflect the file name that generated the routines, this makes it easier to create a general procedure. A number of include / header files are files are generated from different file types (html, xml, js), due some limitations of the windows build system the generated file names had to be changed (the extension in the windows build system is only available including the '.' so e.g. the file jquery_fx.js generates now jquery_fx.js.h instead of jquery_fx_js.h) In the windows version the creation of .cpp files from .l files has been adjusted to correct for the YY_BUF_SIZE problems. Furthermore on windows (and also used on *nix) some commends have been replaced with python scripts so that on windows only python is need (besides flex and bison). On *nix also perl is required for the generation using tmake.
  • Updated Visual Studio project files to include new source files
    • -
  • Usage of the -d opion corrected Giving an error when a wrong -d option is given. Made some error mesages more consistent. Corrected usage of the exit call, in case of an error: exit(1) otherwise exit(0). A closer look should be made on exitDoxygen as it does not contain any exit statements and it is unclear (to me) when it is used.
    • -
  • VHDL-2008 and arrays on unconstrained elements
    • +
  • Usage of the -d option corrected Giving an error when a wrong -d option is given. Made some error messages more consistent. Corrected usage of the exit call, in case of an error: exit(1) otherwise exit(0). A closer look should be made on exitDoxygen as it does not contain any exit statements and it is unclear (to me) when it is used.
  • VHDL-2008 and arrays on unconstrained elements
  • consider currentFile when searching for global symbols
  • doc/language.doc generated from the updated sources (bgcolored)
  • doc/language.tpl -- UTF-8 reflected in the langhowto template
    • @@ -984,7 +983,7 @@

    Bug fixes