Skip to content

Commit

Permalink
Handlingh of -- by \c and <code> results in - adjusted documentation
Browse files Browse the repository at this point in the history
Adjusted documentation so that -- in \c and <code> are shown as -- by placing the parts in ` (backtick)
  • Loading branch information
albert-github committed Jan 12, 2014
1 parent 4b51e61 commit 73d12cc
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion doc/doxygen_usage.doc
Original file line number Diff line number Diff line change
Expand Up @@ -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>,
Expand Down
14 changes: 7 additions & 7 deletions doc/install.doc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion doc/trouble.doc
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down

0 comments on commit 73d12cc

Please sign in to comment.