QPMS
/
qpms
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Doxyfile and README updates. 

Former-commit-id: f7b9eb87be6ba1ac4ab8dcb7590cdac39516b3f1
This commit is contained in:
Marek Nečada 2019-02-27 12:55:47 +02:00
parent 4e4da9d6ad
commit cbb6ee7846
2 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Doxyfile
View File

@ -44,7 +44,7 @@ PROJECT_NUMBER =
# for a project that appears at the top of each page and should give viewer a # 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. # 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 # 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 # the documentation. The maximum height of the logo should not exceed 55 pixels
@ -242,7 +242,7 @@ TCL_SUBST =
# members will be omitted, etc. # members will be omitted, etc.
# The default value is: NO. # 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 # 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 # Python sources only. Doxygen will then generate output that is more tailored

13
README.rst
View File

@ -25,9 +25,12 @@ Documentation
============= =============
Documentation of QPMS is a work in progress. Most of the newer code Documentation of QPMS is a work in progress. Most of the newer code
is documented using doxygen comments. To build the documentation, just run:: is documented using doxygen comments. To build the documentation, just run
``doxygen``
doxygen
in the root directory; the documentation will then be found in 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.