summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorjoq <joq@0c269be4-1314-0410-8aa9-9f06e86f4224>2004-03-28 05:10:38 +0000
committerjoq <joq@0c269be4-1314-0410-8aa9-9f06e86f4224>2004-03-28 05:10:38 +0000
commit1c01d082e11f919028bbbc15f0ddad1b34a2cc3f (patch)
tree275529630d6c531eea27048c6342ad7b72ba5199 /doc
parenta136f6e1ce8db312fe82ee4944cb7266c6109c88 (diff)
downloadjack1-1c01d082e11f919028bbbc15f0ddad1b34a2cc3f.tar.gz
documentation and file formatting updates
git-svn-id: svn+ssh://jackaudio.org/trunk/jack@677 0c269be4-1314-0410-8aa9-9f06e86f4224
Diffstat (limited to 'doc')
-rw-r--r--doc/mainpage.dox18
-rw-r--r--doc/porting.dox4
2 files changed, 11 insertions, 11 deletions
diff --git a/doc/mainpage.dox b/doc/mainpage.dox
index e0a0a80..8fa5917 100644
--- a/doc/mainpage.dox
+++ b/doc/mainpage.dox
@@ -82,15 +82,15 @@ internal client "plugin" that runs within the JACK server process.
The JACK programming interfaces are described in several header files:
- - jack.h defines most of the interfaces used by JACK clients.
- - transport.h provides a simple transport control mechanism for
- starting, stopping and repositioning clients. This is described in
- the @ref transport-design document.
- - types.h defines most of the data types for JACK.
- - ringbuffer.h defines a simple API for using lock-free ringbuffers,
- a very valuable and common data structure in real time streaming
- media software. It is critical for use in applications that do disk
- I/O such as audio file players and recording software.
+ - @ref jack.h "<jack/jack.h>" defines most of the JACK interfaces.
+ - @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
+ audio file playback or recording.
+ - @ref transport.h "<jack/transport.h>" defines a simple transport
+ control mechanism for starting, stopping and repositioning clients.
+ This is described in the @ref transport-design document.
+ - @ref types.h "<jack/types.h>" defines most of the JACK data types.
In addition, the example-clients directory provides numerous examples
of simple JACK clients that nevertheless use the API to do something
diff --git a/doc/porting.dox b/doc/porting.dox
index 69a77b1..8dfc8c8 100644
--- a/doc/porting.dox
+++ b/doc/porting.dox
@@ -52,8 +52,8 @@ Compiler Collective, <http://gcc.gnu.org>.
@section portopsys Operating System Dependencies
JACK is written to conform with C99, as defined in International
-Standard ISO/IEC 9899. Because many existing compilers do not fully
-support this standard, some new features should be avoided for
+Standard ISO/IEC 9899:1999. Because many existing compilers do not
+fully support this standard, some new features should be avoided for
portablility reasons. For example, variables should not be declared
in the middle of a compound statement, because many compilers still
cannot handle that language extension.