annotate src/portaudio_20161030/bindings/cpp/doc/README @ 55:284acf908dcd
Add source for PortAudio stable v190600_20161030
| author |
Chris Cannam |
| date |
Tue, 03 Jan 2017 13:44:07 +0000 |
| parents |
src/portaudio/bindings/cpp/doc/README@e13257ea84a4 |
| children |
|
| rev |
line source |
|
Chris@55
|
1 GNU/Linux:
|
|
Chris@55
|
2 ----------
|
|
Chris@55
|
3
|
|
Chris@55
|
4 1) Download and install a recent version of Doxygen (preferably version 1.3.3 or
|
|
Chris@55
|
5 later). See http://www.doxygen.org/.
|
|
Chris@55
|
6 2) Download and install a recent version of GraphViz. See
|
|
Chris@55
|
7 http://www.research.att.com/sw/tools/graphviz/.
|
|
Chris@55
|
8 3) Run ``doxygen config.doxy.linux'' in this directory or load and generate the file
|
|
Chris@55
|
9 config.doxy.linux from the Doxywizard application. Or alternatively ``make docs'' can
|
|
Chris@55
|
10 be run from the build/gnu folder.
|
|
Chris@55
|
11
|
|
Chris@55
|
12 The generated html documentation will be placed in /doc/api_reference/. To open
|
|
Chris@55
|
13 the main page of the documentation, open the file /doc/api_reference/index.html in
|
|
Chris@55
|
14 an html browser.
|
|
Chris@55
|
15
|
|
Chris@55
|
16
|
|
Chris@55
|
17 Windows:
|
|
Chris@55
|
18 --------
|
|
Chris@55
|
19
|
|
Chris@55
|
20 1) Download and install a recent Doxygen (preferably version 1.3.4 or later). See
|
|
Chris@55
|
21 http://www.doxygen.org/.
|
|
Chris@55
|
22 2) Download and install a recent version of GraphViz. See
|
|
Chris@55
|
23 http://www.research.att.com/sw/tools/graphviz/.
|
|
Chris@55
|
24 3) If needed, edit the config.doxy file in an ascii text editor so that
|
|
Chris@55
|
25 ``DOT_PATH'' variable points to the folder where GraphViz is installed.
|
|
Chris@55
|
26 4) Run ``doxygen config.doxy'' in this directory or load and generate the file
|
|
Chris@55
|
27 config.doxy from the Doxywizard application.
|
|
Chris@55
|
28
|
|
Chris@55
|
29 The generated html documentation will be placed in /doc/api_reference/. To open
|
|
Chris@55
|
30 the main page of the documentation, open the file /doc/api_reference/index.html in
|
|
Chris@55
|
31 an html browser.
|
|
Chris@55
|
32
|
|
Chris@55
|
33
|
|
Chris@55
|
34
|
