index : cpython.git	2.7 3.3 3.4 3.5 3.6 benjamin-clang benjamin-iteration-torture buildbot-custom master
	https://github.com/python/cpython.git

summaryrefslogtreecommitdiffstats

log msg author committer range

path: root/Lib/test/test_codecencodings_cn.py

stat options

Period:	week month quarter
Authors:	102550100all

Commits per author per week (path 'Lib/test/test_codecencodings_cn.py')

Author	W06 2026	W07 2026	W08 2026	W09 2026	Total
Total	0	0	0	0	0

generated by cgit v0.12 at 2026-02-28 10:18:06 (GMT)

\htmlonly --- \endhtmlonly Structural indicators @@ -204,7 +204,7 @@ Doxygen. Unrecognized commands are treated as normal text. \verbinclude class.h \htmlonly Click here - for the corresponding HTML documentation that is generated by Doxygen. + for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly

---

@@ -218,7 +218,7 @@ Doxygen. Unrecognized commands are treated as normal text. \verbinclude define.h \htmlonly Click here - for the corresponding HTML documentation that is generated by Doxygen. + for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly

---

@@ -231,7 +231,7 @@ Doxygen. Unrecognized commands are treated as normal text. categories. You can also use groups as members of other groups, thus building a hierarchy of groups. - The \ argument should be a single word identifier. + The \ argument should be a single-word identifier. \sa page \ref grouping "Grouping", sections \ref cmdingroup "\\ingroup", \ref cmdaddtogroup "\\addtogroup", \ref cmdweakgroup "\\weakgroup". @@ -256,7 +256,7 @@ Doxygen. Unrecognized commands are treated as normal text. \verbinclude enum.h \htmlonly Click here - for the corresponding HTML documentation that is generated by Doxygen. + for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly

---

@@ -271,7 +271,7 @@ Doxygen. Unrecognized commands are treated as normal text. If any are found, the names are cross-referenced with the documentation. Source files or directories can be specified using the \ref cfg_example_path "EXAMPLE_PATH" - tag of Doxygen's configuration file. + tag of doxygen's configuration file. If \ itself is not unique for the set of example files specified by the @@ -287,7 +287,7 @@ Doxygen. Unrecognized commands are treated as normal text. \verbinclude example_test.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 \sa section \ref cmdinclude "\\include". @@ -310,7 +310,7 @@ Doxygen. Unrecognized commands are treated as normal text. \verbinclude file.h \htmlonly Click here - for the corresponding HTML documentation that is generated by Doxygen. + for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly

---

@@ -331,7 +331,7 @@ Doxygen. Unrecognized commands are treated as normal text. \verbinclude func.h \htmlonly Click here - for the corresponding HTML documentation that is generated by Doxygen. + for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly \sa section \ref cmdvar "\\var" and \ref cmdtypedef "\\typedef". @@ -343,7 +343,7 @@ Doxygen. Unrecognized commands are treated as normal text. By default the value of a define and the initializer of a variable are displayed unless they are longer than 30 lines. By putting this command in a comment block of a define or variable, the - initializer always hidden. + initializer is always hidden. \sa section \ref cmdshowinitializer "\\showinitializer". @@ -461,7 +461,7 @@ Public/Protected/Private/... section. \verbinclude examples/overload.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

---

@@ -471,14 +471,14 @@ Public/Protected/Private/... section. Indicates that a comment block contains a piece of documentation that is not directly related to one specific class, file or member. The HTML generator creates a page containing the documentation. The - \htmlonly LaTeX\endhtmlonly\latexonly\LaTeX\ \endlatexonly generator + \f$\mbox{\LaTeX}\f$ generator starts a new section in the chapter `Page documentation'. \par Example: \verbinclude page.doc \htmlonly Click here - for the corresponding HTML documentation that is generated by Doxygen. + for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly \par Note: @@ -509,7 +509,7 @@ Public/Protected/Private/... section. \verbinclude relates.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

---

@@ -537,7 +537,7 @@ Public/Protected/Private/... section. \subsection cmdtypedef \typedef (typedef declaration) \addindex \typedef - Indicates that a comment block contains documentation for a typedef, + Indicates that a comment block contains documentation for a typedef (either global or as a member of a class). This command is equivalent to \\var and \\fn. @@ -557,7 +557,7 @@ Public/Protected/Private/... section. \subsection cmdvar \var (variable declaration) \addindex \var - Indicates that a comment block contains documentation for a variable, + Indicates that a comment block contains documentation for a variable or enum value (either global or as a member of a class). This command is equivalent to \\typedef and \\fn. @@ -606,7 +606,7 @@ Public/Protected/Private/... section. \verbinclude author.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

---

@@ -771,7 +771,7 @@ Public/Protected/Private/... section. \verbinclude par.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

---

@@ -821,7 +821,7 @@ Public/Protected/Private/... section. \subsection cmdremarks \remarks { remark text } \addindex \remarks - Starts a paragraph where one or more marks may be entered. + Starts a paragraph where one or more remarks may be entered. The paragraph will be indented. The text of the paragraph has no special internal structure. All visual enhancement commands may be used inside the paragraph. @@ -847,7 +847,7 @@ Public/Protected/Private/... section. \subsection cmdretval \retval { description } \addindex \retval - Starts a return value for a function with name + Starts a return value description for a function with name \. Followed by a description of the return value. The text of the paragraph that forms the description has no special internal structure. All visual enhancement commands may be used inside the @@ -863,7 +863,7 @@ Public/Protected/Private/... section. \addindex \sa Starts a paragraph where one or more cross-references to classes, functions, methods, variables, files or URL may be specified. - Two names joines by either :: or \# + Two names joined by either :: or \# are understood as referring to a class and one of its members. One of several overloaded methods or constructors may be selected by including a parenthesized list of argument types after @@ -975,7 +975,7 @@ Public/Protected/Private/... section. \subsection cmdlink \link \addindex \link - The links that are automatically generated by Doxygen always have the + The links that are automatically generated by doxygen always have the name of the object they point to as link-text. The \\link command can be used to create a link to an object (a file, @@ -1048,7 +1048,7 @@ Public/Protected/Private/... section. add documentation between the pieces. Source files or directories can be specified using the \ref cfg_example_path "EXAMPLE_PATH" - tag of Doxygen's configuration file. + tag of doxygen's configuration file. The class and member declarations and definitions inside the code fragment are `remembered' during the parsing of the comment block that contained @@ -1065,7 +1065,7 @@ Public/Protected/Private/... section. \verbinclude example_test.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 \sa sections \ref cmdline "\\line", \ref cmdskip "\\skip", @@ -1079,7 +1079,7 @@ Public/Protected/Private/... section. The command takes the name of an include file as an argument. Source files or directories can be specified using the \ref cfg_example_path "EXAMPLE_PATH" - tag of Doxygen's configuration file. + tag of doxygen's configuration file. If \ itself is not unique for the set of example files specified by the @@ -1178,7 +1178,7 @@ Public/Protected/Private/... section. placing \\verbatim and \\endverbatim commands around it. Files or directories that doxygen should look for can be specified using the - \ref cfg_example_path "EXAMPLE_PATH" tag of Doxygen's configuration file. + \ref cfg_example_path "EXAMPLE_PATH" tag of doxygen's configuration file.

---

\subsection cmdhtmlinclude \htmlinclude @@ -1189,7 +1189,7 @@ Public/Protected/Private/... section. placing \\htmlonly and \\endhtmlonly commands around it. Files or directories that doxygen should look for can be specified using the - \ref cfg_example_path "EXAMPLE_PATH" tag of Doxygen's configuration file. + \ref cfg_example_path "EXAMPLE_PATH" tag of doxygen's configuration file.

---

\htmlonly --- \endhtmlonly @@ -1378,7 +1378,7 @@ Public/Protected/Private/... section. endhtmlonly command. This command can be used to include HTML code that is too complex - for Doxygen (i.e. applets, java-scripts, and HTML tags that + for doxygen (i.e. applets, java-scripts, and HTML tags that require attributes). You can use the \\latexonly and \\endlatexonly pair to provide a proper \f$\mbox{\LaTeX}\f$ alternative. @@ -1401,12 +1401,12 @@ Public/Protected/Private/... section. following values are supported: \c html and \c latex. The second argument specifies the file name of the image. - Doxygen will look for files in the paths (or files) that you specified + doxygen will look for files in the paths (or files) that you specified after the \ref cfg_image_path "IMAGE_PATH" tag. If the image is found it will be copied to the correct output directory. If the image name contains spaces you'll have to put quotes (") around it. You can also specify an absolute URL instead of a file name, but then - doxygen does not copy the image or check its existance. + doxygen does not copy the image nor check its existance. The third argument is optional and can be used to specify the caption that is displayed below the image. This argument has to be specified @@ -1439,9 +1439,9 @@ Public/Protected/Private/... section. \warning The image format for HTML is limited to what your browser supports. For \f$\mbox{\LaTeX}\f$ the image format - must be an encapsulated postscipt (eps). + must be Encapsulated PostScipt (eps).

- Doxygen does not check if the image is in the correct format. + doxygen does not check if the image is in the correct format. So \e you have to make sure this is the case!

---

@@ -1453,7 +1453,7 @@ Public/Protected/Private/... section. endlatexonly command. This command can be used to include \f$\mbox{\LaTeX}\f$ code that is too - complex for Doxygen (i.e. images, formulas, special characters). You can + complex for doxygen (i.e. images, formulas, special characters). You can use the \\htmlonly and \\endhtmlonly pair to provide a proper HTML alternative. @@ -1531,7 +1531,7 @@ Public/Protected/Private/... section. \addindex \\ This command writes a backslash character (\\) to the HTML and \f$\mbox{\LaTeX}\f$ output. The backslash has to be escaped in some - cases because Doxygen uses it to detect commands. + cases because doxygen uses it to detect commands.

---

\subsection cmdat \@ @@ -1539,7 +1539,7 @@ Public/Protected/Private/... section. \addindex \@ This command writes an at-sign (@) to the HTML and \f$\mbox{\LaTeX}\f$ output. The at-sign has to be escaped in some cases - because Doxygen uses it to detect JavaDoc commands. + because doxygen uses it to detect JavaDoc commands.

---

\subsection cmdamp \& diff --git a/doc/config.doc b/doc/config.doc index f5d1f1e..13d3991 100644 --- a/doc/config.doc +++ b/doc/config.doc @@ -14,7 +14,7 @@ * input used in their production; they are not affected by this license. * */ -/*! \page config +/*! \page config Configuration \section config Configuration @@ -213,7 +213,7 @@ followed by the descriptions of the tags grouped by category.

\c OUTPUT_DIRECTORY

\addindex OUTPUT_DIRECTORY The \c OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) - path into which the generated HTML and Latex documentation will be written. + path into which the generated documentation will be written. If a relative path is entered, it will be relative to the location where doxygen was started. If left blank the current directory will be used. @@ -254,7 +254,7 @@ followed by the descriptions of the tags grouped by category. \anchor cfg_hide_undoc_members

\c HIDE_UNDOC_MEMBERS

\addindex HIDE_UNDOC_MEMBERS - If the \c HIDE_UNDOC_MEMBERS tag is set to \c YES, Doxygen will hide all + If the \c HIDE_UNDOC_MEMBERS tag is set to \c YES, doxygen will hide all undocumented members inside documented classes or files. If set to \c NO (the default) these members will be included in the various overviews, but no documentation section is generated. @@ -263,7 +263,7 @@ followed by the descriptions of the tags grouped by category. \anchor cfg_hide_undoc_classes

\c HIDE_UNDOC_CLASSES

\addindex HIDE_UNDOC_CLASSES - If the \c HIDE_UNDOC_CLASSESS tag is set to \c YES, Doxygen will hide all + If the \c HIDE_UNDOC_CLASSESS tag is set to \c YES, doxygen will hide all undocumented classes. If set to \c NO (the default) these classes will be included in the various overviews. @@ -272,7 +272,7 @@ followed by the descriptions of the tags grouped by category. \anchor cfg_brief_member_desc

\c BRIEF_MEMBER_DESC

\addindex BRIEF_MEMBER_DESC - If the \c BRIEF_MEMBER_DESC tag is set to \c YES (the default) Doxygen will + If the \c BRIEF_MEMBER_DESC tag is set to \c YES (the default) doxygen will include brief member descriptions after the members that are listed in the file and class documentation (similar to JavaDoc). Set to NO to disable this. @@ -280,7 +280,7 @@ followed by the descriptions of the tags grouped by category. \anchor cfg_repeat_brief

\c REPEAT_BRIEF

\addindex REPEAT_BRIEF - If the \c REPEAT_BRIEF tag is set to \c YES (the default) Doxygen will + If the \c REPEAT_BRIEF tag is set to \c YES (the default) doxygen will prepend the brief description of a member or function before the detailed description @@ -292,13 +292,13 @@ followed by the descriptions of the tags grouped by category.

\c ALWAYS_DETAILED_SEC

\addindex ALWAYS_DETAILED_SEC If the \c ALWAYS_DETAILED_SEC and \c REPEAT_BRIEF tags are both set to \c YES then - Doxygen will generate a detailed section even if there is only a brief + doxygen will generate a detailed section even if there is only a brief description. \anchor cfg_full_path_names

\c FULL_PATH_NAMES

\addindex FULL_PATH_NAMES - If the \c FULL_PATH_NAMES tag is set to \c YES Doxygen will prepend the full + If the \c FULL_PATH_NAMES tag is set to \c YES doxygen will prepend the full path before files name in the file list and in the header files. If set to NO the shortest path that makes the file name unique will be used @@ -321,8 +321,8 @@ followed by the descriptions of the tags grouped by category. \anchor cfg_class_diagrams

\c CLASS_DIAGRAMS

\addindex CLASS_DIAGRAMS - If the \c CLASS_DIAGRAMS tag is set to \c YES (the default) Doxygen will - generate a class diagram (in Html and \f$\mbox{\LaTeX}\f$) for classes with base or + If the \c CLASS_DIAGRAMS tag is set to \c YES (the default) doxygen will + generate a class diagram (in HTML and \f$\mbox{\LaTeX}\f$) for classes with base or super classes. Setting the tag to \c NO turns the diagrams off. \anchor cfg_source_browser @@ -347,7 +347,7 @@ followed by the descriptions of the tags grouped by category. \anchor cfg_case_sense_names

\c CASE_SENSE_NAMES

\addindex CASE_SENSE_NAMES - If the \c CASE_SENSE_NAMES tag is set to \c NO (the default) then Doxygen + If the \c CASE_SENSE_NAMES tag is set to \c NO (the default) then doxygen will only generate file names in lower case letters. If set to \c YES upper case letters are also allowed. This is useful if you have classes or files whose names only differ in case and if your file system @@ -363,14 +363,14 @@ followed by the descriptions of the tags grouped by category. \anchor cfg_hide_scope_names

\c HIDE_SCOPE_NAMES

\addindex HIDE_SCOPE_NAMES - If the \c HIDE_SCOPE_NAMES tag is set to \c NO (the default) then Doxygen + If the \c HIDE_SCOPE_NAMES tag is set to \c NO (the default) then doxygen will show members with their full class and namespace scopes in the documentation. If set to \c YES the scope will be hidden. \anchor cfg_verbatim_headers

\c VERBATIM_HEADERS

\addindex VERBATIM_HEADERS - If the \c VERBATIM_HEADERS tag is set the \c YES (the default) then Doxygen + If the \c VERBATIM_HEADERS tag is set the \c YES (the default) then doxygen will generate a verbatim copy of the header file for each class for which an include is specified. Set to NO to disable this. \sa Section \ref cmdclass "\\class". @@ -378,14 +378,14 @@ followed by the descriptions of the tags grouped by category. \anchor cfg_show_include_files

\c SHOW_INCLUDE_FILES

\addindex SHOW_INCLUDE_FILES - If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen + If the SHOW_INCLUDE_FILES tag is set to YES (the default) then doxygen will put list of the files that are included by a file in the documentation of that file. \anchor cfg_javadoc_autobrief

\c JAVADOC_AUTOBRIEF

\addindex JAVADOC_AUTOBRIEF - If the \c JAVADOC_AUTOBRIEF is set to \c YES then Doxygen + If the \c JAVADOC_AUTOBRIEF is set to \c YES then doxygen will interpret the first line (until the first dot) of a JavaDoc-style comment as the brief description. If set to NO (the default), the Javadoc-style will behave just like the Qt-style comments. @@ -665,7 +665,7 @@ followed by the descriptions of the tags grouped by category.

\c GENERATE_HTML

\addindex GENERATE_HTML - If the \c GENERATE_HTML tag is set to \c YES (the default) Doxygen will + If the \c GENERATE_HTML tag is set to \c YES (the default) doxygen will generate HTML output \anchor cfg_html_output @@ -760,16 +760,16 @@ followed by the descriptions of the tags grouped by category. \c index.hhp, \c index.hhc, and \c index.hhk. The \c index.hhp is a project file that can be read by - Microsoft HTML help workshop + Microsoft HTML Help Workshop \latexonly (see http://msdn.microsoft.com/library/tools/htmlhelp/wkshp/download\_main.htm) \endlatexonly on Windows. - The HTML workshop contains a compiler that can convert all HTML output + The HTML Help Workshop contains a compiler that can convert all HTML output generated by doxygen into a single compressed HTML file (.chm). Compressed HTML files are now used as the Windows 98 help format, and will replace - the old windows help format (.hlp) on all Windows platforms in the future. + the old Windows help format (.hlp) on all Windows platforms in the future. Compressed HTML files also contain an index, a table of contents, and you can search for words in the documentation (which basically renders \c doxysearch obsolete on Windows). @@ -792,8 +792,8 @@ followed by the descriptions of the tags grouped by category. \anchor cfg_toc_expand

\c TOC_EXPAND

\addindex TOC_EXPAND - The \c TOC_EXPAND flag can be set YES to add extra items for - group members to the table of contents of the Html help documentation + The \c TOC_EXPAND flag can be set to YES to add extra items for + group members to the table of contents of the HTML help documentation and to the tree view. \anchor cfg_disable_index @@ -834,8 +834,8 @@ followed by the descriptions of the tags grouped by category.

\c GENERATE_LATEX

\addindex GENERATE_LATEX - If the \c GENERATE_LATEX tag is set to \c YES (the default) Doxygen will - generate Latex output. + If the \c GENERATE_LATEX tag is set to \c YES (the default) doxygen will + generate \f$\mbox{\LaTeX}\f$ output. \anchor cfg_latex_output

\c LATEX_OUTPUT

@@ -848,7 +848,7 @@ followed by the descriptions of the tags grouped by category. \anchor cfg_compact_latex

\c COMPACT_LATEX

\addindex COMPACT_LATEX - If the \c COMPACT_LATEX tag is set to \c YES Doxygen generates more compact + If the \c COMPACT_LATEX tag is set to \c YES doxygen generates more compact \f$\mbox{\LaTeX}\f$ documents. This may be useful for small projects and may help to save some trees in general. @@ -881,8 +881,8 @@ EXTRA_PACKAGES = times

\c LATEX_HEADER

\addindex LATEX_HEADER The \c LATEX_HEADER tag can be used to specify a personal \f$\mbox{\LaTeX}\f$ - header for the generated latex document. The header should contain everything - until the first chapter. + header for the generated \f$\mbox{\LaTeX}\f$ document. + The header should contain everything until the first chapter. If it is left blank doxygen will generate a standard header. See section \ref doxygen_usage for information on how to @@ -904,10 +904,11 @@ EXTRA_PACKAGES = times

\c PDF_HYPERLINKS

\addindex PDF_HYPERLINKS - If the \c PDF_HYPERLINKS tag is set to \c YES, the LaTeX that is generated - is prepared for conversion to pdf (using ps2pdf). The pdf file will + If the \c PDF_HYPERLINKS tag is set to \c YES, the \f$\mbox{\LaTeX}\f$ that + is generated is prepared for conversion to PDF (using ps2pdf). + The PDF file will contain links (just like the HTML output) instead of page references - This makes the output suitable for online browsing using a pdf viewer. + This makes the output suitable for online browsing using a PDF viewer. \anchor cfg_latex_batchmode

\c LATEX_BATCHMODE

@@ -926,7 +927,7 @@ EXTRA_PACKAGES = times

\c GENERATE_RTF

\addindex GENERATE_RTF - If the \c GENERATE_RTF tag is set to \c YES Doxygen will generate RTF output. + If the \c GENERATE_RTF tag is set to \c YES doxygen will generate RTF output. The RTF output is optimised for Word 97 and may not look too pretty with other readers/editors. @@ -940,7 +941,7 @@ EXTRA_PACKAGES = times \anchor cfg_compact_rtf

\c COMPACT_RTF

\addindex COMPACT_RTF - If the \c COMPACT_RTF tag is set to \c YES Doxygen generates more compact + If the \c COMPACT_RTF tag is set to \c YES doxygen generates more compact RTF documents. This may be useful for small projects and may help to save some trees in general. @@ -954,7 +955,7 @@ EXTRA_PACKAGES = times Word compatible reader that support those fields. \par note: - wordpad (write) and others do not support links. + WordPad (write) and others do not support links. \anchor cfg_rtf_stylesheet_file

\c RTF_STYLESHEET_FILE

@@ -968,7 +969,7 @@ EXTRA_PACKAGES = times \anchor cfg_rtf_extensions_file

\c RTF_EXTENSIONS_FILE

- Set optional variables used in the generation of an rtf document. + Set optional variables used in the generation of an RTF document. Syntax is similar to doxygen's config file. A template extensions file can be generated using doxygen -e rtf extensionFile. @@ -981,7 +982,7 @@ EXTRA_PACKAGES = times

\c GENERATE_MAN

\addindex GENERATE_MAN - If the \c GENERATE_MAN tag is set to \c YES (the default) Doxygen will + If the \c GENERATE_MAN tag is set to \c YES (the default) doxygen will generate man pages for classes and files. \anchor cfg_man_output @@ -1002,7 +1003,7 @@ EXTRA_PACKAGES = times \anchor cfg_man_links

\c MAN_LINKS

\addindex MAN_LINKS - If the \c MAN_LINKS tag is set to \c YES and Doxygen generates man output, + If the \c MAN_LINKS tag is set to \c YES and doxygen generates man output, then it will generate one additional man file for each entity documented in the real man page(s). These additional files only source the real man page, but without them the man command would be unable to find the correct page. @@ -1016,14 +1017,14 @@ EXTRA_PACKAGES = times

\c ENABLE_PREPROCESSING

\addindex ENABLE_PREPROCESSING - If the \c ENABLE_PREPROCESSING tag is set to \c YES (the default) Doxygen will + If the \c ENABLE_PREPROCESSING tag is set to \c YES (the default) doxygen will evaluate all C-preprocessor directives found in the sources and include files. \anchor cfg_macro_expansion

\c MACRO_EXPANSION

\addindex MACRO_EXPANSION - If the \c MACRO_EXPANSION tag is set to \c YES Doxygen will expand all macro + If the \c MACRO_EXPANSION tag is set to \c YES doxygen will expand all macro names in the source code. If set to \c NO (the default) only conditional compilation will be performed. Macro expansion can be done in a controlled way by setting \c EXPAND_ONLY_PREDEF to \c YES. @@ -1039,7 +1040,7 @@ EXTRA_PACKAGES = times

\c SEARCH_INCLUDES

\addindex SEARCH_INCLUDES If the \c SEARCH_INCLUDES tag is set to \c YES (the default) the includes files - in the \c INCLUDE_PATH (see below) will be search if a \#include is found. + in the \c INCLUDE_PATH (see below) will be searched if a \#include is found. \anchor cfg_include_path

\c INCLUDE_PATH

@@ -1195,7 +1196,7 @@ TAGFILES = file1=loc1 "file2 = loc2" ... \anchor cfg_generate_legend

\c GENERATE_LEGEND

\addindex GENERATE_LEGEND - If the \c GENERATE_LEGEND tag is set to \c YES (the default) Doxygen will + If the \c GENERATE_LEGEND tag is set to \c YES (the default) doxygen will generate a legend page explaining the meaning of the various boxes and arrows in the dot generated graphs. @@ -1222,7 +1223,7 @@ TAGFILES = file1=loc1 "file2 = loc2" ...

\c CGI_URL

\addindex CGI_URL The \c CGI_URL tag should be the absolute URL to the directory where the - cgi binaries are located. See the documentation of your http daemon for + cgi binaries are located. See the documentation of your HTTP daemon for details. \anchor cfg_doc_url @@ -1363,7 +1364,7 @@ EXPAND_AS_DEFINED = Q_OBJECT_FAKE Q_OBJECT ACTIVATE_SIGNAL_WITH_PARAM \ Q_VARIANT_AS \endverbatim -Here Doxygen's preprocessor is used to substitute some +Here doxygen's preprocessor is used to substitute some macro names that are normally substituted by the C preprocessor, but without doing full macro expansion. diff --git a/doc/diagrams.doc b/doc/diagrams.doc index 2153f16..3217800 100644 --- a/doc/diagrams.doc +++ b/doc/diagrams.doc @@ -61,7 +61,7 @@ little marker in the lower right corner to indicate that the class contains base classes that are hidden. For the class diagrams the maximum tree width is currently 8 elements. - If a tree wider some nodes will be hidden. + If a tree is wider some nodes will be hidden. If the box is filled with a dashed pattern the inheritance relation is virtual.

A \b white box indicates that the documentation of the class @@ -81,7 +81,7 @@ If the box has a \b dashed border this indicates virtual inheritance.

A \b solid arrow indicates public inheritance.

A \b dashed arrow indicates protected inheritance. -

A \b dotted arrow indicated private inheritance. +

A \b dotted arrow indicates private inheritance. The elements in the graphs generated by the dot tool have the following @@ -91,7 +91,7 @@

A box with a \b red border indicates a node that has \e more arrows than are shown! In order words: the graph is \e truncated with respect to this node. - The reason a graph is sometimes truncated is too prevent images + The reason a graph is sometimes truncated is to prevent images from becoming too large. For the graphs generated with dot doxygen tries to limit the width of the resulting image to 1024 pixels. diff --git a/doc/docblocks.doc b/doc/docblocks.doc index 547e617..bb73ccb 100644 --- a/doc/docblocks.doc +++ b/doc/docblocks.doc @@ -204,7 +204,7 @@ Here is an example of the use of these comment blocks: for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly -\warning These blocks can only be used to document \e members. +\warning These blocks can only be used to document \e members and \e parameters. They cannot be used to document files, classes, unions, structs, groups, namespaces and enums themselves. Furthermore, the structural commands mentioned in the previous section diff --git a/doc/doxygen_usage.doc b/doc/doxygen_usage.doc index 5796896..865f5ca 100644 --- a/doc/doxygen_usage.doc +++ b/doc/doxygen_usage.doc @@ -44,7 +44,7 @@ doxygen If you have a configuration file generated with an older version of -doxygen that you can upgrade it to the current version by running doxygen +doxygen, you can upgrade it to the current version by running doxygen with the -u option. \verbatim doxygen -u @@ -85,7 +85,7 @@ doxygen -w rtf rtfstyle.cfg file then you can use the optional \c -s option. This can use be used in combination with the \c -u option, to add or strip the documentation from an existing configuration file. - Please use the \c -s this option if you send me a configuration file + Please use the \c -s option if you send me a configuration file as part of a bug report!

To make doxygen read/write to standard input/output instead of from/to a file, use \c - for the file name. diff --git a/doc/doxysearch_usage.doc b/doc/doxysearch_usage.doc index 72dc397..6d6ad29 100644 --- a/doc/doxysearch_usage.doc +++ b/doc/doxysearch_usage.doc @@ -27,7 +27,7 @@ Doxysearch must be run as a CGI binary. This implies the following:

You must have permission to install and execute a CGI binary on the target. -Ask you system administrator or provider if you are unsure if this is possible. +Ask your system administrator or provider if you are unsure if this is possible. In order to be able to search fast and efficient, doxysearch does not search the generated documentation directly. Instead, it uses an @@ -131,8 +131,8 @@ This can be done by carefully following these steps: \par Note: Doxytag requires quite a large amount of memory to - generate the search index (about 30 Mb on my Linux box)! - The resulting index file requires about 3 Mb space on your disk. + generate the search index (about 30 MB on my Linux box)! + The resulting index file requires about 3 MB space on your disk.

Edit the shell script search.cgi with a text editor. @@ -174,7 +174,7 @@ http://blizzard/cgi-bin/search.cgi \endverbatim in the additional information section of the index.html file.

Start your favourite web browser and click on the link. - If everything is ok, you should get a page where you can enter + If everything is OK, you should get a page where you can enter search terms. diff --git a/doc/external.doc b/doc/external.doc index d8f4285..f3a1e05 100644 --- a/doc/external.doc +++ b/doc/external.doc @@ -45,7 +45,7 @@ To generate a tag file for your project, simply put the name of the tag file after the \ref cfg_generate_tagfile "GENERATE_TAGFILE" option in the configuration file. -To combine the output of one or more external projects with you own project +To combine the output of one or more external projects with your own project you should specify the name of the tag files after the \ref cfg_tagfiles "TAGFILES" option in the configuration file. @@ -57,7 +57,7 @@ There are two ways to do this:

At configuration time:

just assign the location of the output to the tag files specified after the \ref cfg_tagfiles "TAGFILES" configuration option. If you use a relative path it should be relative with respect to - the directory where the html output of your project is generated. + the directory where the HTML output of your project is generated.

After compile time:

if you do not assign a location to a tag file, doxygen will generate dummy links for all external HTML references. It will also generate a perl script called \ref installdox_usage "installdox" in diff --git a/doc/faq.doc b/doc/faq.doc index 7b4894b..f20dfc0 100644 --- a/doc/faq.doc +++ b/doc/faq.doc @@ -91,7 +91,7 @@ around the blocks that should be hidden and put: in the config file then all blocks should be skipped by Doxygen as long as PREPROCESSING = YES. -

How can I change what's after the \#include in the class documentation? +

How can I change what is after the \#include in the class documentation? You can document your class like @@ -119,7 +119,7 @@ brackets you should type: */ \endverbatim -

How can I use tag files in combination with compressed HTML +

How can I use tag files in combination with compressed HTML? If you want to refer from one compressed HTML file \c a.chm to another compressed HTML file @@ -160,7 +160,7 @@ doxygen generates. You can include this by putting \verbatim \endverbatim -In the