summaryrefslogtreecommitdiffstats
path: root/doc/docblocks.doc
diff options
context:
space:
mode:
authoralbert-github <albert.tests@gmail.com>2018-10-29 12:11:22 (GMT)
committeralbert-github <albert.tests@gmail.com>2018-10-29 12:11:22 (GMT)
commitd42f1d1bbb3cd73f71ee2c57791d31ff37d5d0f1 (patch)
tree9a159a1521745751b087b6dc9b3caf91eab0052f /doc/docblocks.doc
parent94701b844c77861bc39a077bd5c91b52faa2d3f1 (diff)
downloadDoxygen-d42f1d1bbb3cd73f71ee2c57791d31ff37d5d0f1.zip
Doxygen-d42f1d1bbb3cd73f71ee2c57791d31ff37d5d0f1.tar.gz
Doxygen-d42f1d1bbb3cd73f71ee2c57791d31ff37d5d0f1.tar.bz2
Spelling of the word Javadoc
The current spelling (also for the older versions) is Javadoc. Changed on all possible documentation visible places (external and internal).
Diffstat (limited to 'doc/docblocks.doc')
-rw-r--r--doc/docblocks.doc12
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/docblocks.doc b/doc/docblocks.doc
index ab144af..a9cb05a 100644
--- a/doc/docblocks.doc
+++ b/doc/docblocks.doc
@@ -55,7 +55,7 @@ used to provide tooltips at places where an item is referenced.
There are several ways to mark a comment block as a detailed description:
<ol>
-<li> You can use the JavaDoc style, which consist of a C-style comment
+<li> You can use the Javadoc style, which consist of a C-style comment
block starting with two *'s, like this:
\verbatim
@@ -143,7 +143,7 @@ Here is an example:
<li>If \ref cfg_javadoc_autobrief "JAVADOC_AUTOBRIEF" is set to \c YES
in the configuration file,
- then using JavaDoc style comment
+ then using Javadoc style comment
blocks will automatically start a brief description which ends at the
first dot followed by a space or new line. Here is an example:
@@ -299,8 +299,8 @@ sentence of the detailed descriptions
tag to \c NO). Both the brief and the detailed descriptions are optional
for the Qt style.
-By default a JavaDoc style documentation block behaves the same way as a
-Qt style documentation block. This is not according the JavaDoc specification
+By default a Javadoc style documentation block behaves the same way as a
+Qt style documentation block. This is not according the Javadoc specification
however, where the first sentence of the documentation block is automatically
treated as a brief description. To enable this behavior you should set
\ref cfg_javadoc_autobrief "JAVADOC_AUTOBRIEF" to YES in the configuration
@@ -312,7 +312,7 @@ Here is an example:
\endverbatim
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:
+Javadoc style and \ref cfg_javadoc_autobrief "JAVADOC_AUTOBRIEF" set to YES:
\include jdstyle.cpp
\htmlonly
</p>
@@ -348,7 +348,7 @@ duplication of information. So in practice you should \e avoid the use of
structural commands \e unless other requirements force you to do so.
Structural commands (like \ref cmd_intro "all other commands") start with a backslash
-(<tt>\\</tt>), or an at-sign (<tt>\@</tt>) if you prefer JavaDoc style,
+(<tt>\\</tt>), or an at-sign (<tt>\@</tt>) if you prefer Javadoc style,
followed by a command name and one or more parameters.
For instance, if you want to document the class \c Test in the example
above, you could have also put the following documentation block somewhere