utils/iaxclient/lib/portaudio/bindings/cpp/doc/README

   1 GNU/Linux:\r
   2 ----------\r
   3 \r
   4 1) Download and install a recent version of Doxygen (preferably version 1.3.3 or \r
   5 later). See http://www.doxygen.org/.\r
   6 2) Download and install a recent version of GraphViz. See \r
   7 http://www.research.att.com/sw/tools/graphviz/.\r
   8 3) Run ``doxygen config.doxy.linux'' in this directory or load and generate the file \r
   9 config.doxy.linux from the Doxywizard application. Or alternatively ``make docs'' can \r
  10 be run from the build/gnu folder.\r
  11 \r
  12 The generated html documentation will be placed in /doc/api_reference/. To open \r
  13 the main page of the documentation, open the file /doc/api_reference/index.html in \r
  14 an html browser.\r
  15 \r
  16 \r
  17 Windows:\r
  18 --------\r
  19 \r
  20 1) Download and install a recent Doxygen (preferably version 1.3.4 or later). See \r
  21 http://www.doxygen.org/.\r
  22 2) Download and install a recent version of GraphViz. See \r
  23 http://www.research.att.com/sw/tools/graphviz/.\r
  24 3) If needed, edit the config.doxy file in an ascii text editor so that \r
  25 ``DOT_PATH'' variable points to the folder where GraphViz is installed.\r
  26 4) Run ``doxygen config.doxy'' in this directory or load and generate the file \r
  27 config.doxy from the Doxywizard application.\r
  28 \r
  29 The generated html documentation will be placed in /doc/api_reference/. To open \r
  30 the main page of the documentation, open the file /doc/api_reference/index.html in \r
  31 an html browser.\r
  32 \r
  33 \r
  34 \r