diff options
author | joq <joq@0c269be4-1314-0410-8aa9-9f06e86f4224> | 2004-11-28 00:29:46 +0000 |
---|---|---|
committer | joq <joq@0c269be4-1314-0410-8aa9-9f06e86f4224> | 2004-11-28 00:29:46 +0000 |
commit | 6dcf31179c66aa27318913e79525f654f15bcb9c (patch) | |
tree | 50bf28515668932b03c624d0542605287d3f7237 /doc | |
parent | 7cc82b9e162e2e199c857237116ff8488857bbfb (diff) | |
download | jack1-6dcf31179c66aa27318913e79525f654f15bcb9c.tar.gz |
[0.99.14] jack_client_open() part 2
git-svn-id: svn+ssh://jackaudio.org/trunk/jack@806 0c269be4-1314-0410-8aa9-9f06e86f4224
Diffstat (limited to 'doc')
-rw-r--r-- | doc/Makefile.am | 12 | ||||
-rw-r--r-- | doc/mainpage.dox | 4 | ||||
-rw-r--r-- | doc/reference.doxygen.in | 9 |
3 files changed, 17 insertions, 8 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index cba0b8c..dda0b49 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -5,9 +5,15 @@ CLEANFILES=doxygen-build.stamp DOX=reference.doxygen DOXSOURCES=mainpage.dox transport.dox porting.dox fsm.png fsm.eps \ - ../jack/jack.h ../jack/types.h ../jack/transport.h \ - ../jack/ringbuffer.h ../jack/thread.h ../jack/port.h \ - ../example-clients/simple_client.c ../example-clients/inprocess.c + ../example-clients/inprocess.c \ + ../example-clients/simple_client.c \ + ../jack/intclient.h \ + ../jack/jack.h \ + ../jack/port.h \ + ../jack/ringbuffer.h \ + ../jack/thread.h \ + ../jack/transport.h \ + ../jack/types.h EXTRA_DIST=mainpage.dox transport.dox fsm.png fsm.eps porting.dox diff --git a/doc/mainpage.dox b/doc/mainpage.dox index efc2c59..06dc055 100644 --- a/doc/mainpage.dox +++ b/doc/mainpage.dox @@ -63,7 +63,7 @@ programs are not all running synchronously. Using JACK within your program is very simple, and typically consists of just: - - calling @ref jack_client_open to connect to the JACK server. + - calling @ref jack_client_open() to connect to the JACK server. - registering "ports" to enable data to be moved to and from your application. - registering a "process callback" which will be called at the @@ -83,6 +83,8 @@ internal client "plugin" that runs within the JACK server process. The JACK programming interfaces are described in several header files: - @ref jack.h "<jack/jack.h>" defines most of the JACK interfaces. + - @ref intclient.h "<jack/intclient.h>" defines interfaces for + loading and unloading JACK internal clients. - @ref ringbuffer.h "<jack/ringbuffer.h>" defines a simple API for using lock-free ringbuffers. These are a good way to pass data between threads, when streaming realtime data to slower media, like diff --git a/doc/reference.doxygen.in b/doc/reference.doxygen.in index 3992ad5..bf929f4 100644 --- a/doc/reference.doxygen.in +++ b/doc/reference.doxygen.in @@ -365,13 +365,14 @@ WARN_LOGFILE = INPUT = @top_srcdir@/doc/mainpage.dox \ @top_srcdir@/doc/transport.dox \ @top_srcdir@/doc/porting.dox \ + @top_srcdir@/example-clients/inprocess.c \ + @top_srcdir@/example-clients/simple_client.c \ + @top_srcdir@/jack/intclient.h \ @top_srcdir@/jack/jack.h \ - @top_srcdir@/jack/types.h \ - @top_srcdir@/jack/transport.h \ @top_srcdir@/jack/ringbuffer.h \ @top_srcdir@/jack/thread.h \ - @top_srcdir@/example-clients/simple_client.c \ - @top_srcdir@/example-clients/inprocess.c + @top_srcdir@/jack/transport.h \ + @top_srcdir@/jack/types.h # If the value of the INPUT tag contains directories, you can use the # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp |