From 4f80d144f98fc998de5118855eec73797a65bf2e Mon Sep 17 00:00:00 2001 From: Dimitri van Heesch Date: Sun, 3 Jan 2016 16:37:34 +0100 Subject: Adjusted Doxygen to doxygen in running text in the manual --- doc/arch.doc | 2 +- doc/autolink.doc | 6 +++--- doc/changelog.doc | 14 +++++++------- doc/commands.doc | 6 +++--- doc/faq.doc | 6 +++--- doc/features.doc | 2 +- doc/grouping.doc | 4 ++-- doc/markdown.doc | 2 +- doc/perlmod.doc | 22 +++++++++++----------- doc/starting.doc | 4 ++-- doc/trouble.doc | 4 ++-- 11 files changed, 36 insertions(+), 36 deletions(-) diff --git a/doc/arch.doc b/doc/arch.doc index 7876fb9..57d05d4 100644 --- a/doc/arch.doc +++ b/doc/arch.doc @@ -115,7 +115,7 @@ on the tree of entries, built during language parsing. Look at the "Gathering information" part of \c parseInput() for details. The result of this step is a number of dictionaries, which can be -found in the Doxygen "namespace" defined in \c src/doxygen.h. Most +found in the doxygen "namespace" defined in \c src/doxygen.h. Most elements of these dictionaries are derived from the class \c Definition; The class \c MemberDef, for instance, holds all information for a member. An instance of such a class can be part of a file ( class \c FileDef ), diff --git a/doc/autolink.doc b/doc/autolink.doc index b434dd2..98556c5 100644 --- a/doc/autolink.doc +++ b/doc/autolink.doc @@ -38,7 +38,7 @@ documentation by links (in HTML). To manually specify link text, use the HTML 'a' tag: \verbatim link text \endverbatim - which will be automatically translated to other output formats by Doxygen. + which will be automatically translated to other output formats by doxygen. \section linkclass Links to classes @@ -113,7 +113,7 @@ \include autolink.cpp \htmlonly Click here - for the corresponding HTML documentation that is generated by Doxygen. + for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly \latexonly See \hyperlink{autolink_example}{Autolink example} @@ -133,7 +133,7 @@ typedef struct StructName TypeName \include restypedef.cpp \htmlonly Click here - for the corresponding HTML documentation that is generated by Doxygen. + for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly \latexonly See \hyperlink{restypedef_8cpp}{Typedef example} diff --git a/doc/changelog.doc b/doc/changelog.doc index 81efdfc..31e9a49 100644 --- a/doc/changelog.doc +++ b/doc/changelog.doc @@ -145,7 +145,7 @@
  • [Doxygen-users] plugin / filter not behaving as expected [view]
  • add spaces like "Doyxgen"CN_SPC->"Doyxgen" CN_SPC [view]
  • allow building with custom iconv on Windows [view]
    • -
  • doc: generate Doxygen's documentation. [view]
    • +
  • doc: generate doxygen's documentation. [view]
  • doc: put man pages under share/man/man1 [view]
  • docparser: warn when finding a documented empty return type [view]
  • docs: add examples as a dependency of docs [view]
    • @@ -272,7 +272,7 @@
  • Removed OS version check for MACOSX (was not used anywhere) [view]
  • Removed dbus XML parser, various refinements [view], [view]
  • Removed old build files, added install targets and other options [view]
    • -
  • Repair Doxygen generate invalid styleSheetFile and extensionsFile of RTF [view]
    • +
  • Repair doxygen generate invalid styleSheetFile and extensionsFile of RTF [view]
  • Replace to_c_cmd by resource compiler [view]
  • Restore deleted file [view]
  • Showing grey/gray in documentation [view]
    • @@ -552,7 +552,7 @@
  • Bug 731238 Dead links in html documentation when using tabs for indentation in c++ [view]
  • Bug 731363 Callgraphs for C# only generated for methods inside the same class [view]
  • Bug 731985 Variadic macros failing to expand if trailing ... is empty [view]
    • -
  • Bug 732594 Two entries for a single member in Doxygen XML [view]
    • +
  • Bug 732594 Two entries for a single member in doxygen XML [view]
  • Bug 732768 nested html tables cause pdflatex to hang (1.8.4 and 1.8.6) [view]
  • Bug 733451 volatile declaration on member functions is not handled as xml attribute [view]
  • Bug 733605 Incorrect LaTeX generation for private union member in C++ [view]
    • @@ -617,7 +617,7 @@
  • Messages truncated in warnings file [view]
  • Minor fixes [view]
  • Minor fixes to the template context [view]
    • -
  • Missing word after \n command in Doxygen rtf output, version 1.8.5 & up [view]
    • +
  • Missing word after \n command in doxygen rtf output, version 1.8.5 & up [view]
  • More robust extraction of scope information from tag files [view]
  • No warning in case cite definition is missing [view]
  • Preparations for release 1.8.8 [view]
    • @@ -664,7 +664,7 @@
  • Bug 436885 - c-source and h-source missing for latex [view]
  • Bug 625601 - FORTRAN: recognition free versus fixed formatted code [view]
  • Bug 626172 - Latex $projectname with "&" gets no escaped [view]
    • -
  • Bug 643618 - Fortran: variable with name "type" confuses Doxygen [view]
    • +
  • Bug 643618 - Fortran: variable with name "type" confuses doxygen [view]
  • Bug 674851 - Percent to prevent auto-linking in page title is not removed for navpath [view]
  • Bug 678436 - Nested \if messes up list items [view]
  • Bug 678436 - Nested \if messes up list items [view]
    • @@ -684,7 +684,7 @@
  • Bug 722603 - doxygen nested \if \endif sample not working [view]
  • Bug 722619 - doxygen 1.8.6 sorts the contents of a namespace by group within the Class List [view]
  • Bug 722711 - Link refs with no title swallow an extra newline [view]
    • -
  • Bug 722759 - Documentation for derived classes no longer has an "Additional Inherited Members" section after upgrading Doxygen from 1.8.3.1 to 1.8.6 [view]
    • +
  • Bug 722759 - Documentation for derived classes no longer has an "Additional Inherited Members" section after upgrading doxygen from 1.8.3.1 to 1.8.6 [view]
  • Bug 722786 - configure --prefix=/opt/foo not accepted [view]
  • Bug 722788 - Command \| not working when last character in markdown table line [view]
  • Bug 723299 - Last line of code block lost if it is only one character and there is no text afterward [view]
    • @@ -1036,7 +1036,7 @@
  • jquery: use the env MINIFIER if specified
  • Some words now in code style __attribute__ was seen (markdown) as the bold word attribute Reformulation of a sentence due to a not nice split of word (__declspec was split directly after __ in pdf)
  • Extended list with supported options for automatic link generation
    • -
  • Added -v option (analogous to --version). In case option started with -- and is not a known valuue (help or version) and error is given instead of starting Doxygen
    • +
  • Added -v option (analogous to --version). In case option started with -- and is not a known valuue (help or version) and error is given instead of starting doxygen
  • Fixed regression when nested class were processed before their parent
  • Minor changes to the way the code for config options is generated (thanks to Albert for the patch)
  • Brief description did not appear in the page index, when a page did not have any details.
    • diff --git a/doc/commands.doc b/doc/commands.doc index 313e518..a7af089 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -876,7 +876,7 @@ Structural indicators Indicates that the member documented by the comment block is private, i.e., should only be accessed by other members in the same class. - Note that Doxygen automatically detects the protection level of members + Note that doxygen automatically detects the protection level of members in object-oriented languages. This command is intended for use only when the language does not support the concept of protection level natively (e.g. C, PHP 4). @@ -919,7 +919,7 @@ Structural indicators i.e., should only be accessed by other members in the same or derived classes. - Note that Doxygen automatically detects the protection level of members + Note that doxygen automatically detects the protection level of members in object-oriented languages. This command is intended for use only when the language does not support the concept of protection level natively (e.g. C, PHP 4). @@ -960,7 +960,7 @@ Structural indicators Indicates that the member documented by the comment block is public, i.e., can be accessed by any other class or function. - Note that Doxygen automatically detects the protection level of members + Note that doxygen automatically detects the protection level of members in object-oriented languages. This command is intended for use only when the language does not support the concept of protection level natively (e.g. C, PHP 4). diff --git a/doc/faq.doc b/doc/faq.doc index bd327a1..d1845e0 100644 --- a/doc/faq.doc +++ b/doc/faq.doc @@ -97,12 +97,12 @@ with a \ref cmdcond "\\cond" command at the start and one comment block with a \ref cmdendcond "\\endcond" command at the end of the piece of code that should be ignored. This should be within the same file of course. -But you can also use Doxygen's preprocessor for this: +But you can also use doxygen's preprocessor for this: If you put \verbatim #ifndef DOXYGEN_SHOULD_SKIP_THIS - /* code that must be skipped by Doxygen */ + /* code that must be skipped by doxygen */ #endif /* DOXYGEN_SHOULD_SKIP_THIS */ \endverbatim @@ -110,7 +110,7 @@ around the blocks that should be hidden and put: \verbatim PREDEFINED = DOXYGEN_SHOULD_SKIP_THIS \endverbatim -in the config file then all blocks should be skipped by Doxygen as long +in the config file then all blocks should be skipped by doxygen as long as \ref cfg_enable_preprocessing "ENABLE_PREPROCESSING" is set to `YES`. \section faq_code_inc How can I change what is after the \#include in the class documentation? diff --git a/doc/features.doc b/doc/features.doc index dd75a9d..f6aa7c1 100644 --- a/doc/features.doc +++ b/doc/features.doc @@ -107,7 +107,7 @@ one that is generated by Qt Software. Doxygen understands the C++ extensions used by Qt such as signals and slots and many of the markup commands used in the Qt sources. Doxygen can also automatically generate links to existing documentation -that was generated with Doxygen or with Qt's non-public class browser +that was generated with doxygen or with Qt's non-public class browser generator. For a Qt based project this means that whenever you refer to members or classes belonging to the Qt toolkit, a link will be generated to the Qt documentation. This is done independent of where this documentation diff --git a/doc/grouping.doc b/doc/grouping.doc index 64102e1..bdb16e3 100644 --- a/doc/grouping.doc +++ b/doc/grouping.doc @@ -140,7 +140,7 @@ in .c files without having to duplicate the hierarchy exactly. \htmlonly

    Click here -for the corresponding HTML documentation that is generated by Doxygen. +for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly \latexonly See \hyperlink{modules_example}{Modules example} @@ -198,7 +198,7 @@ documentation of the class. \htmlonly

    Click here -for the corresponding HTML documentation that is generated by Doxygen. +for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly \latexonly See \hyperlink{memgrp_example}{Member Groups example} diff --git a/doc/markdown.doc b/doc/markdown.doc index cec2191..b525fe9 100644 --- a/doc/markdown.doc +++ b/doc/markdown.doc @@ -511,7 +511,7 @@ is noticeable: code In this case Markdown will put the word code in a code block, -whereas Doxygen will treat it as normal text, since although the absolute +whereas doxygen will treat it as normal text, since although the absolute indentation is 4, the indentation with respect to the previous paragraph is only 1. diff --git a/doc/perlmod.doc b/doc/perlmod.doc index 8616dc6..3d2e2c2 100644 --- a/doc/perlmod.doc +++ b/doc/perlmod.doc @@ -2,19 +2,19 @@ \addindex perlmod -

    Since version 1.2.18, Doxygen can generate a new output format we +

    Since version 1.2.18, doxygen can generate a new output format we have called the "Perl Module output format". It has been designed as an intermediate format that can be used to generate new -and customized output without having to modify the Doxygen source. +and customized output without having to modify the doxygen source. Therefore, its purpose is similar to the XML output format that can be -also generated by Doxygen. The XML output format is more standard, +also generated by doxygen. The XML output format is more standard, but the Perl Module output format is possibly simpler and easier to use.

    The Perl Module output format is still experimental at the moment and could be changed in incompatible ways in future versions, although this should not be very probable. It is also lacking some features of -other Doxygen backends. However, it can be already used to generate +other doxygen backends. However, it can be already used to generate useful output, as shown by the Perl Module-based \LaTeX generator.

    Please report any bugs or problems you find in the Perl Module @@ -24,7 +24,7 @@ doxygen-develop mailing list. Suggestions are welcome as well. \section using_perlmod_fmt Usage

    When the \ref cfg_generate_perlmod "GENERATE_PERLMOD" tag is enabled in the Doxyfile, -running Doxygen generates a number of files in the `perlmod/` +running doxygen generates a number of files in the `perlmod/` subdirectory of your output directory. These files are the following:

    To make use of the documentation stored in DoxyDocs.pm you can use -one of the default Perl Module-based generators provided by Doxygen +one of the default Perl Module-based generators provided by doxygen (at the moment this includes the Perl Module-based \LaTeX generator, see \ref perlmod_latex "below") or write your own customized generator. This should not be too hard if you have some knowledge of Perl and it's the main purpose of including the Perl Module backend in -Doxygen. See \ref doxydocs_format "below" for details on how +doxygen. See \ref doxydocs_format "below" for details on how to do this. <-- want to use \LaTeX but not possible in headings --> @@ -114,7 +114,7 @@ packages used by `doxylatex.tex`. \ref cfg_perlmod_latex "PERLMOD_LATEX" tags to \c YES in your Doxyfile. -

  • Run Doxygen on your Doxyfile: +
  • Run doxygen on your Doxyfile: 
    doxygen Doxyfile
    @@ -137,7 +137,7 @@ in DVI format. \section doxydocs_format Documentation format. -

    The Perl Module documentation generated by Doxygen is stored in +

    The Perl Module documentation generated by doxygen is stored in `DoxyDocs.pm`. This is a very simple Perl module that contains only two statements: an assignment to the variable `$doxydocs` and the customary `1;` statement which usually ends Perl modules. @@ -183,12 +183,12 @@ present in \ref perlmod_tree "this page".

    You might be interested in processing the documentation contained in `DoxyDocs.pm` without needing to take into account the semantics of each node of the documentation tree. For this purpose, -Doxygen generates a `DoxyModel.pm` file which contains a data +doxygen generates a `DoxyModel.pm` file which contains a data structure describing the type and children of each node in the documentation tree.

    The rest of this section is to be written yet, but in the meantime -you can look at the Perl scripts generated by Doxygen (such as +you can look at the Perl scripts generated by doxygen (such as `doxylatex.pl` or `doxytemplate-latex.pl`) to get an idea on how to use `DoxyModel.pm`. diff --git a/doc/starting.doc b/doc/starting.doc index 081ef8b..f82e90d 100644 --- a/doc/starting.doc +++ b/doc/starting.doc @@ -24,7 +24,7 @@ detailed usage information. Optionally, the executable \c doxywizard can be used, which is a \ref doxywizard_usage "graphical front-end" for editing the configuration file that is used by doxygen and for running doxygen in a graphical environment. -For Mac OS X doxywizard will be started by clicking on the Doxygen application +For Mac OS X doxywizard will be started by clicking on the doxygen application icon. The following figure shows the relation between the tools and the flow @@ -37,7 +37,7 @@ tries to be complete): \section step0 Step 0: Check if doxygen supports your programming language First, assure that your programming language has a reasonable chance of being -recognized by Doxygen. These languages are supported by default: C, C++, C#, +recognized by doxygen. These languages are supported by default: C, C++, C#, Objective-C, IDL, Java, VHDL, PHP, Python, Tcl, Fortran, and D. It is possible to configure certain file type extensions to use certain parsers: see the \ref cfg_extension_mapping "Configuration/ExtensionMappings" for details. diff --git a/doc/trouble.doc b/doc/trouble.doc index 47ef623..9584c0c 100644 --- a/doc/trouble.doc +++ b/doc/trouble.doc @@ -81,9 +81,9 @@ \section howtohelp How to Help -The development of Doxygen highly depends on your input! +The development of doxygen highly depends on your input! -If you are trying Doxygen let me know what you think of it (do you +If you are trying doxygen let me know what you think of it (do you miss certain features?). Even if you decide not to use it, please let me know why. -- cgit v0.12