zdoom/fluidsynth
0
0
Fork 0
mirror of https://github.com/ZDoom/fluidsynth.git synced 2025-04-09 09:11:02 +00:00
Code Issues Projects Releases Packages Wiki Activity

Build documentation instructions.

Browse source
This commit is contained in:
Pedro Lopez-Cabanillas 2010-12-04 09:01:00 +00:00
parent 864bd7a7f0
commit ed9720b38b
2 changed files with 12 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
fluidsynth/README.cmake
View file

@ -71,6 +71,11 @@ There is a "clean" target, but not a "distclean" one. You should use a build
directory different to the source tree. In this case, the "distclean" target
would be equivalent to simply removing the build directory.
To compile the developer documentation, use this command from the root build
directory:
$ make doxygen
If something fails
==================

9
fluidsynth/doc/README
View file

@ -1,6 +1,11 @@
To build FluidSynth API reference documentation, make sure you have Doxygen
installed and execute the following command in the doc/ directory:
make doxygen
installed.
If you are using the cmake build system, change to the root build directory.
If you are using the deprecated auto-tools based build system, execute the
following command in this doc/ directory:
$ make doxygen
The latest generated API HTML docs can also be found, along with other
information, on the Wiki documentation page: