Doxyfile and README updates.
Former-commit-id: f7b9eb87be6ba1ac4ab8dcb7590cdac39516b3f1
This commit is contained in:
parent
4e4da9d6ad
commit
cbb6ee7846
4
Doxyfile
4
Doxyfile
|
@ -44,7 +44,7 @@ PROJECT_NUMBER =
|
|||
# for a project that appears at the top of each page and should give viewer a
|
||||
# quick idea about the purpose of the project. Keep the description short.
|
||||
|
||||
PROJECT_BRIEF =
|
||||
PROJECT_BRIEF = "Electromagnetic multiple scattering library and toolkit."
|
||||
|
||||
# With the PROJECT_LOGO tag one can specify an logo or icon that is included in
|
||||
# the documentation. The maximum height of the logo should not exceed 55 pixels
|
||||
|
@ -242,7 +242,7 @@ TCL_SUBST =
|
|||
# members will be omitted, etc.
|
||||
# The default value is: NO.
|
||||
|
||||
OPTIMIZE_OUTPUT_FOR_C = NO
|
||||
OPTIMIZE_OUTPUT_FOR_C = YES
|
||||
|
||||
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
|
||||
# Python sources only. Doxygen will then generate output that is more tailored
|
||||
|
|
13
README.rst
13
README.rst
|
@ -25,9 +25,12 @@ Documentation
|
|||
=============
|
||||
|
||||
Documentation of QPMS is a work in progress. Most of the newer code
|
||||
is documented using doxygen comments. To build the documentation, just run::
|
||||
|
||||
doxygen
|
||||
|
||||
is documented using doxygen comments. To build the documentation, just run
|
||||
``doxygen``
|
||||
in the root directory; the documentation will then be found in
|
||||
``docs/index.html``.
|
||||
``docs/html/index.html``.
|
||||
|
||||
Of course, the prerequisite of this is having doxygen installed.
|
||||
If you don't, you will probably find it easily in your OS's
|
||||
repositories. On Debian and derivatives, simply run ``apt-get install doxygen``
|
||||
under root.
|
||||
|
|
Loading…
Reference in New Issue