Browse Source

doc fixes to add session API and other tweaks

git-svn-id: svn+ssh://jackaudio.org/trunk/jack@4131 0c269be4-1314-0410-8aa9-9f06e86f4224
tags/0.120.1
paul 15 years ago
parent
commit
4f53ebe6a6
3 changed files with 8 additions and 3 deletions
  1. +2
    -1
      doc/Makefile.am
  2. +4
    -1
      doc/mainpage.dox
  3. +2
    -1
      doc/reference.doxygen.in

+ 2
- 1
doc/Makefile.am View File

@@ -14,7 +14,8 @@ DOXSOURCES=mainpage.dox transport.dox porting.dox fsm.png fsm.eps \
../jack/thread.h \
../jack/transport.h \
../jack/types.h \
../jack/midiport.h
../jack/midiport.h \
../jack/session.h

EXTRA_DIST=mainpage.dox transport.dox fsm.png fsm.eps porting.dox



+ 4
- 1
doc/mainpage.dox View File

@@ -96,6 +96,7 @@ little clearer:
- @ref ErrorOutput
- @ref NonCallbackAPI
- @ref MIDIAPI
- @ref SessionClientFunctions

The full API is described in:

@@ -116,6 +117,8 @@ The full API is described in:
creation for JACK and its clients.
- @ref midiport.h "<jack/midiport.h>" functions to handle reading
and writing of MIDI data to a port
- @ref session.h "<jack/session.h>" functions that form the JACK
session API

In addition, the tools directory provides numerous examples
of simple JACK clients that nevertheless use the API to do something
@@ -141,7 +144,7 @@ porting-guide document.

@section license License

Copyright (C) 2001-2008 by Paul Davis and others.
Copyright (C) 2001-2011 by Paul Davis, Stephane Letz, Jack O'Quinn, Torben Hohn and others.

JACK is free software; you can redistribute it and/or modify it under
the terms of the GNU GPL and LGPL licenses as published by the Free


+ 2
- 1
doc/reference.doxygen.in View File

@@ -525,7 +525,8 @@ INPUT = @top_srcdir@/doc/mainpage.dox \
@top_srcdir@/jack/thread.h \
@top_srcdir@/jack/transport.h \
@top_srcdir@/jack/types.h \
@top_srcdir@/jack/midiport.h
@top_srcdir@/jack/midiport.h \
@top_srcdir@/jack/session.h

# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is


Loading…
Cancel
Save