Update API documentation and Doxyfile to improve the output.

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@18822 a95241bf-73f2-0310-859d-f6bbb57e9c96
This commit is contained in:
Niels Sascha Reedijk
2006-09-12 12:13:49 +00:00
parent 946d88f90b
commit d419ca3b7b
13 changed files with 581 additions and 233 deletions
+10 -2
View File
@@ -1,5 +1,11 @@
/*!
\page midi2 The new Midi Kit (libmidi2.so)
\ingroup midi2
*/
/*\{*/
/*!
\page midi2intro
The Midi Kit is the API that implements support for generating, processing, and
playing music in MIDI format. <A HREF="http://www.midi.org/">MIDI</A>, which
@@ -282,7 +288,7 @@ as the BeOS R5 kits, although there are a few small differences in the API
More about the Midi Kit:
- \ref midi2defs
- \subpage midi2defs
- Be Newsletter Volume 3, Issue 47 - Motor Mix sample code
- Be Newsletter Volume 4, Issue 3 - Overview of the new kit
- <A HREF="http://open-beos.sourceforge.net/nsl.php?mode=display&id=33">OpenBeOS
@@ -301,3 +307,5 @@ Information about MIDI in general:
- <A HREF="http://www.io.com/~jimm/midi_ref.html">Jim Menard's MIDI Reference</A>
*/
/*\}*/
+2
View File
@@ -1,5 +1,7 @@
/*!
\class BMidiConsumer MidiConsumer.h
\ingroup midi2
\ingroup libmidi2
\brief Receives MIDI events from a producer
A consumer is an object that knows how to deal with incoming MIDI events. A
+2
View File
@@ -1,5 +1,7 @@
/*!
\class BMidiEndpoint MidiEndpoint.h
\ingroup midi2
\ingroup libmidi2
\brief Base class for all MIDI endpoints
BMidiEndpoint is the abstract base class that represents either a producer or
+31
View File
@@ -0,0 +1,31 @@
*!
\file Midi2Defs.h
\ingroup midi2
\brief General Defines for the MIDI2 kit
Please see \ref midi2defs for more information.
*/
/*!
\file MidiConsumer.h
\ingroup midi2
\brief Defines consumer classes for the MIDI Kit
*/
/*!
\file MidiProducer.h
\ingroup midi2
\brief Defines producer classes for the MIDI Kit
*/
/*!
\file MidiEndpoint.h
\ingroup midi2
\brief Defines the Baseclass of all MIDI consumers and producers
*/
/*!
\file MidiRoster.h
\ingroup midi2
\brief Defines the heart of the MIDI Kit: the MIDI Roster
*/
+2
View File
@@ -1,5 +1,7 @@
/*!
\class BMidiLocalConsumer MidiConsumer.h
\ingroup midi2
\ingroup libmidi2
\brief A consumer endpoint that is created by your own application
If you want to create a consumer that reacts to MIDI events, you should
+2
View File
@@ -1,5 +1,7 @@
/*!
\class BMidiLocalProducer MidiProducer.h
\ingroup midi2
\ingroup libmidi2
\brief A producer endpoint that is created by your own application
You create a BMidiLocalProducer if you want your application to send MIDI
+2
View File
@@ -1,5 +1,7 @@
/*!
\class BMidiProducer MidiProducer.h
\ingroup midi2
\ingroup libmidi2
\brief Streams MIDI events to connected consumers
A producer is an object that generate a stream of MIDI events. Each producer
+2
View File
@@ -1,5 +1,7 @@
/*!
\class BMidiRoster MidiRoster.h
\ingroup midi2
\ingroup libmidi2
\brief Interface to the system-wide Midi Roster
BMidiRoster allows you to find available MIDI consumer and producer objects.