summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authoralbert-github <albert.tests@gmail.com>2014-01-12 15:36:09 (GMT)
committeralbert-github <albert.tests@gmail.com>2014-01-12 15:36:09 (GMT)
commit73d12cc5cf0656e94125baea62cdb19b67908b3d (patch)
treed93df18cf7fe28f7c07078010b1665d211e095b4 /doc
parent4b51e6113f1e9e20a5700840d83f1c3928d84825 (diff)
downloadDoxygen-73d12cc5cf0656e94125baea62cdb19b67908b3d.zip
Doxygen-73d12cc5cf0656e94125baea62cdb19b67908b3d.tar.gz
Doxygen-73d12cc5cf0656e94125baea62cdb19b67908b3d.tar.bz2
Handlingh of -- by \c and <code> results in - adjusted documentation
Adjusted documentation so that -- in \c and <code> are shown as -- by placing the parts in ` (backtick)
Diffstat (limited to 'doc')
-rw-r--r--doc/doxygen_usage.doc2
-rw-r--r--doc/install.doc14
-rw-r--r--doc/trouble.doc2
3 files changed, 9 insertions, 9 deletions
diff --git a/doc/doxygen_usage.doc b/doc/doxygen_usage.doc
index ddad5d7..b7fdc40 100644
--- a/doc/doxygen_usage.doc
+++ b/doc/doxygen_usage.doc
@@ -17,7 +17,7 @@
/*! \page doxygen_usage Doxygen usage
Doxygen is a command line based utility. Calling \c doxygen with the
-\c --help option at the command line will give you a brief description of the
+`--help` option at the command line will give you a brief description of the
usage of the program.
All options consist of a leading character <tt>-</tt>,
diff --git a/doc/install.doc b/doc/install.doc
index 94f1099..d0878b3 100644
--- a/doc/install.doc
+++ b/doc/install.doc
@@ -94,7 +94,7 @@ Compilation is now done by performing the following steps:
If you have Qt-4.3 or higher installed and want to build the GUI
front-end, you should run the configure script with
- the <code>--with-doxywizard</code> option:
+ the `--with-doxywizard` option:
configure --with-doxywizard
@@ -148,10 +148,10 @@ Use <code>make install_docs</code> to install the
documentation and examples into <code>\<docdir\>/doxygen</code>.
<code>\<prefix\></code> defaults to <code>/usr/local</code> but can be changed with
-the <code>--prefix</code> option of the configure script.
+the `--prefix` option of the configure script.
The default <code>\<docdir\></code> directory is
<code>\<prefix\>/share/doc/packages</code> and can be changed with
-the <code>--docdir</code> option of the configure script.
+the `--docdir` option of the configure script.
Alternatively, you can also copy the binaries from the <code>bin</code>
directory manually to some <code>bin</code> directory in your search path.
@@ -226,14 +226,14 @@ Manually adding `-Bdynamic` after the target rule in
Older versions of the GNU compiler have problems with constant strings
containing characters with character codes larger than 127. Therefore
-the compiler will fail to compile some of the translator_xx.h files.
+the compiler will fail to compile some of the `translator_xx.h` files.
A workaround, if you are planning to use the English translation only,
-is to configure doxygen with the <code>--english-only</code> option.
+is to configure doxygen with the `--english-only` option.
On some platforms (such as OpenBSD) using some versions of gcc with
-O2 can lead to eating all memory during the compilation of files
-such as config.cpp. As a workaround use --debug as a configure option
-or omit the -O2 for the particular files in the Makefile.
+such as config.cpp. As a workaround use `--debug` as a configure option
+or omit the `-O2` for the particular files in the Makefile.
Gcc versions before 2.95 may produce broken binaries due to bugs in
these compilers.
diff --git a/doc/trouble.doc b/doc/trouble.doc
index c71e63d..84fb835 100644
--- a/doc/trouble.doc
+++ b/doc/trouble.doc
@@ -109,7 +109,7 @@ helpful and it will cost me much more time to figure out what you mean.
In the worst-case your bug report may even be completely ignored by me, so
always try to include the following information in your bug report:
- The version of doxygen you are using (for instance 1.5.3, use
- <code>doxygen --version</code> if you are not sure).
+ `doxygen --version` if you are not sure).
- The name and version number of your operating system (for instance
SuSE Linux 6.4)
- It is usually a good idea to send along the configuration file as well,