summaryrefslogtreecommitdiffstats
path: root/doc/commands.doc
diff options
context:
space:
mode:
authoralbert-github <albert.tests@gmail.com>2014-04-13 16:41:25 (GMT)
committeralbert-github <albert.tests@gmail.com>2014-04-13 16:41:25 (GMT)
commitd63a7d8812c7f748a48d76bfc39ce57f79f6f667 (patch)
tree56fdeb925473387c0f839b6b90482c6f4550b19b /doc/commands.doc
parent385b87e08c23b1392d0e6d6fbdb6ef463fa28477 (diff)
downloadDoxygen-d63a7d8812c7f748a48d76bfc39ce57f79f6f667.zip
Doxygen-d63a7d8812c7f748a48d76bfc39ce57f79f6f667.tar.gz
Doxygen-d63a7d8812c7f748a48d76bfc39ce57f79f6f667.tar.bz2
Consistency of usage of the word LaTeX in the documentation
The word LaTeX was used as just the word and on other places as \f$\mbox{\LaTeX}\f$ This has been made more consistent by means of the definition of the Alia \LaTeX (similar for \TeX) Some names of executables etc. were not set in a 'code' font.
Diffstat (limited to 'doc/commands.doc')
-rw-r--r--doc/commands.doc26
1 files changed, 13 insertions, 13 deletions
diff --git a/doc/commands.doc b/doc/commands.doc
index 0f36e61..5743832 100644
--- a/doc/commands.doc
+++ b/doc/commands.doc
@@ -632,7 +632,7 @@ Structural indicators
If the \c \\mainpage command is placed in a comment block the
block is used to customize the index page (in HTML) or
- the first chapter (in \f$\mbox{\LaTeX}\f$).
+ the first chapter (in \LaTeX).
The title argument is optional and replaces the default title that
doxygen normally generates. If you do not want any title you can
@@ -763,7 +763,7 @@ Structural indicators
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
- \f$\mbox{\LaTeX}\f$ generator
+ \LaTeX generator
starts a new section in the chapter 'Page documentation'.
\par Example:
@@ -1777,7 +1777,7 @@ Commands to create links
\section cmdaddindex \\addindex (text)
\addindex \\addindex
- This command adds (text) to the \f$\mbox{\LaTeX}\f$ index.
+ This command adds (text) to the \LaTeX index.
<hr>
\section cmdanchor \\anchor <word>
@@ -1799,7 +1799,7 @@ Commands to create links
Adds a bibliographic reference in the text and in the list of bibliographic
references. The \<label\> must be a valid BibTeX label that can be found
in one of the .bib files listed in \ref cfg_cite_bib_files "CITE_BIB_FILES".
- For the LaTeX output the formatting of the reference in the text can be
+ For the \LaTeX output the formatting of the reference in the text can be
configured with \ref cfg_latex_bib_style "LATEX_BIB_STYLE". For other
output formats a fixed representation is used. Note that using this
command requires the \c bibtex tool to be present in the search path.
@@ -1837,7 +1837,7 @@ Commands to create links
the section. For a section or subsection the title of the section will be
used as the text of the link. For an anchor the optional text between quotes
will be used or \<name\> if no text is specified.
- For \f$\mbox{\LaTeX}\f$ documentation the reference command will
+ For \LaTeX documentation the reference command will
generate a section number for sections or the text followed by a
page number if \<name\> refers to an anchor.
@@ -2230,7 +2230,7 @@ Commands for displaying examples
\section cmdlatexinclude \\latexinclude <file-name>
\addindex \\latexinclude
- This command includes the file \<file-name\> as is in the LaTeX documentation.
+ This command includes the file \<file-name\> as is in the \LaTeX documentation.
The command is equivalent to pasting the file in the documentation and
placing \ref cmdlatexonly "\\latexonly" and \ref cmdendlatexonly "\\endlatexonly"
commands around it.
@@ -2784,10 +2784,10 @@ class Receiver
The fourth argument is also optional and can be used to specify the
width or height of the image. This is only useful
- for \f$\mbox{\LaTeX}\f$ output
+ for \LaTeX output
(i.e. format=<code>latex</code>). The \c sizeindication can be
either \c width or \c height. The size should be a valid
- size specifier in \f$\mbox{\LaTeX}\f$ (for example <code>10cm</code> or
+ size specifier in \LaTeX (for example <code>10cm</code> or
<code>6in</code> or a symbolic width like <code>\\textwidth</code>).
Here is example of a comment block:
@@ -2807,7 +2807,7 @@ class Receiver
\endverbatim
\warning The image format for HTML is limited to what your
- browser supports. For \f$\mbox{\LaTeX}\f$, the image format
+ browser supports. For \LaTeX, the image format
must be Encapsulated PostScript (eps).
<br><br>
Doxygen does not check if the image is in the correct format.
@@ -2818,17 +2818,17 @@ class Receiver
\addindex \\latexonly
Starts a block of text that will be verbatim included in the
- generated \f$\mbox{\LaTeX}\f$ documentation only. The block ends with a
+ generated \LaTeX documentation only. The block ends with a
\ref cmdendlatexonly "\\endlatexonly" command.
- This command can be used to include \f$\mbox{\LaTeX}\f$ code that is too
+ This command can be used to include \LaTeX code that is too
complex for doxygen (i.e. images, formulas, special characters). You can
use the \ref cmdhtmlonly "\\htmlonly" and \ref cmdendhtmlonly "\\endhtmlonly"
pair to provide a proper HTML alternative.
\b Note:
environment variables (like \$(HOME) ) are resolved inside a
- \f$\mbox{\LaTeX}\f$-only block.
+ \LaTeX-only block.
\sa sections \ref cmdrtfonly "\\rtfonly",
\ref cmdxmlonly "\\xmlonly",
@@ -2849,7 +2849,7 @@ class Receiver
\ref cmdendhtmlonly "\\endhtmlonly" and
\ref cmdlatexonly "\\latexonly" and
\ref cmdendlatexonly "\\endlatexonly" pairs to provide proper
- HTML and \f$\mbox{\LaTeX}\f$ alternatives.
+ HTML and \LaTeX alternatives.
\sa sections \ref cmdhtmlonly "\\htmlonly",
\ref cmdxmlonly "\\xmlonly",