To check out this repository please hg clone the following URL, or open the URL using EasyMercurial or your preferred Mercurial client.

The primary repository for this project is hosted at https://github.com/sonic-visualiser/sv-dependency-builds .
This repository is a read-only copy which is updated automatically every hour.

Statistics Download as Zip
| Branch: | Tag: | Revision:

root / src / portaudio_20161030_catalina_patch / bindings / cpp / doc / README @ 162:d43aab368df9

History | View | Annotate | Download (1.3 KB)

1 
GNU/Linux:
2 
----------
3 

    		
  

  

    
      4
    
    
      
1) Download and install a recent version of Doxygen (preferably version 1.3.3 or 


    		
  

  

    
      5
    
    
      
later). See http://www.doxygen.org/.


    		
  

  

    
      6
    
    
      
2) Download and install a recent version of GraphViz. See 


    		
  

  

    
      7
    
    
      
http://www.research.att.com/sw/tools/graphviz/.


    		
  

  

    
      8
    
    
      
3) Run ``doxygen config.doxy.linux'' in this directory or load and generate the file 


    		
  

  

    
      9
    
    
      
config.doxy.linux from the Doxywizard application. Or alternatively ``make docs'' can 


    		
  

  

    
      10
    
    
      
be run from the build/gnu folder.


    		
  

  

    
      11
    
    
      

    		
  

  

    
      12
    
    
      
The generated html documentation will be placed in /doc/api_reference/. To open 


    		
  

  

    
      13
    
    
      
the main page of the documentation, open the file /doc/api_reference/index.html in 


    		
  

  

    
      14
    
    
      
an html browser.


    		
  

  

    
      15
    
    
      

    		
  

  

    
      16
    
    
      

    		
  

  

    
      17
    
    
      
Windows:


    		
  

  

    
      18
    
    
      
--------


    		
  

  

    
      19
    
    
      

    		
  

  

    
      20
    
    
      
1) Download and install a recent Doxygen (preferably version 1.3.4 or later). See 


    		
  

  

    
      21
    
    
      
http://www.doxygen.org/.


    		
  

  

    
      22
    
    
      
2) Download and install a recent version of GraphViz. See 


    		
  

  

    
      23
    
    
      
http://www.research.att.com/sw/tools/graphviz/.


    		
  

  

    
      24
    
    
      
3) If needed, edit the config.doxy file in an ascii text editor so that 


    		
  

  

    
      25
    
    
      
``DOT_PATH'' variable points to the folder where GraphViz is installed.


    		
  

  

    
      26
    
    
      
4) Run ``doxygen config.doxy'' in this directory or load and generate the file 


    		
  

  

    
      27
    
    
      
config.doxy from the Doxywizard application.


    		
  

  

    
      28
    
    
      

    		
  

  

    
      29
    
    
      
The generated html documentation will be placed in /doc/api_reference/. To open 


    		
  

  

    
      30
    
    
      
the main page of the documentation, open the file /doc/api_reference/index.html in 


    		
  

  

    
      31
    
    
      
an html browser.


    		
  

  

    
      32
    
    
      

    		
  

  

    
      33
    
    
      

    		
  

  

    
      34