Mercurial > hg > sv-dependency-builds
annotate src/portaudio_20161030_catalina_patch/bindings/cpp/doc/README @ 169:223a55898ab9 tip default
Add null config files
| author | Chris Cannam <cannam@all-day-breakfast.com> |
|---|---|
| date | Mon, 02 Mar 2020 14:03:47 +0000 |
| parents | d43aab368df9 |
| children |
| rev | line source |
|---|---|
| cannam@162 | 1 GNU/Linux: |
| cannam@162 | 2 ---------- |
| cannam@162 | 3 |
| cannam@162 | 4 1) Download and install a recent version of Doxygen (preferably version 1.3.3 or |
| cannam@162 | 5 later). See http://www.doxygen.org/. |
| cannam@162 | 6 2) Download and install a recent version of GraphViz. See |
| cannam@162 | 7 http://www.research.att.com/sw/tools/graphviz/. |
| cannam@162 | 8 3) Run ``doxygen config.doxy.linux'' in this directory or load and generate the file |
| cannam@162 | 9 config.doxy.linux from the Doxywizard application. Or alternatively ``make docs'' can |
| cannam@162 | 10 be run from the build/gnu folder. |
| cannam@162 | 11 |
| cannam@162 | 12 The generated html documentation will be placed in /doc/api_reference/. To open |
| cannam@162 | 13 the main page of the documentation, open the file /doc/api_reference/index.html in |
| cannam@162 | 14 an html browser. |
| cannam@162 | 15 |
| cannam@162 | 16 |
| cannam@162 | 17 Windows: |
| cannam@162 | 18 -------- |
| cannam@162 | 19 |
| cannam@162 | 20 1) Download and install a recent Doxygen (preferably version 1.3.4 or later). See |
| cannam@162 | 21 http://www.doxygen.org/. |
| cannam@162 | 22 2) Download and install a recent version of GraphViz. See |
| cannam@162 | 23 http://www.research.att.com/sw/tools/graphviz/. |
| cannam@162 | 24 3) If needed, edit the config.doxy file in an ascii text editor so that |
| cannam@162 | 25 ``DOT_PATH'' variable points to the folder where GraphViz is installed. |
| cannam@162 | 26 4) Run ``doxygen config.doxy'' in this directory or load and generate the file |
| cannam@162 | 27 config.doxy from the Doxywizard application. |
| cannam@162 | 28 |
| cannam@162 | 29 The generated html documentation will be placed in /doc/api_reference/. To open |
| cannam@162 | 30 the main page of the documentation, open the file /doc/api_reference/index.html in |
| cannam@162 | 31 an html browser. |
| cannam@162 | 32 |
| cannam@162 | 33 |
| cannam@162 | 34 |