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:
+494
-208
File diff suppressed because it is too large
Load Diff
+8
-1
@@ -6,5 +6,12 @@
|
|||||||
- \ref midi1
|
- \ref midi1
|
||||||
- \ref midi2
|
- \ref midi2
|
||||||
- \ref support
|
- \ref support
|
||||||
- \ref ppp
|
*/
|
||||||
|
|
||||||
|
/*!
|
||||||
|
\defgroup midi2 MIDI 2 Kit
|
||||||
|
\defgroup libmidi2 (libmidi2.so)
|
||||||
|
\defgroup support Support Kit
|
||||||
|
\defgroup libbe (libbe.so)
|
||||||
|
\defgroup libroot (libroot.so)
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -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
|
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
|
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:
|
More about the Midi Kit:
|
||||||
|
|
||||||
- \ref midi2defs
|
- \subpage midi2defs
|
||||||
- Be Newsletter Volume 3, Issue 47 - Motor Mix sample code
|
- Be Newsletter Volume 3, Issue 47 - Motor Mix sample code
|
||||||
- Be Newsletter Volume 4, Issue 3 - Overview of the new kit
|
- 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
|
- <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>
|
- <A HREF="http://www.io.com/~jimm/midi_ref.html">Jim Menard's MIDI Reference</A>
|
||||||
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
/*\}*/
|
||||||
|
|||||||
@@ -1,5 +1,7 @@
|
|||||||
/*!
|
/*!
|
||||||
\class BMidiConsumer MidiConsumer.h
|
\class BMidiConsumer MidiConsumer.h
|
||||||
|
\ingroup midi2
|
||||||
|
\ingroup libmidi2
|
||||||
\brief Receives MIDI events from a producer
|
\brief Receives MIDI events from a producer
|
||||||
|
|
||||||
A consumer is an object that knows how to deal with incoming MIDI events. A
|
A consumer is an object that knows how to deal with incoming MIDI events. A
|
||||||
|
|||||||
@@ -1,5 +1,7 @@
|
|||||||
/*!
|
/*!
|
||||||
\class BMidiEndpoint MidiEndpoint.h
|
\class BMidiEndpoint MidiEndpoint.h
|
||||||
|
\ingroup midi2
|
||||||
|
\ingroup libmidi2
|
||||||
\brief Base class for all MIDI endpoints
|
\brief Base class for all MIDI endpoints
|
||||||
|
|
||||||
BMidiEndpoint is the abstract base class that represents either a producer or
|
BMidiEndpoint is the abstract base class that represents either a producer or
|
||||||
|
|||||||
@@ -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
|
||||||
|
*/
|
||||||
@@ -1,5 +1,7 @@
|
|||||||
/*!
|
/*!
|
||||||
\class BMidiLocalConsumer MidiConsumer.h
|
\class BMidiLocalConsumer MidiConsumer.h
|
||||||
|
\ingroup midi2
|
||||||
|
\ingroup libmidi2
|
||||||
\brief A consumer endpoint that is created by your own application
|
\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
|
If you want to create a consumer that reacts to MIDI events, you should
|
||||||
|
|||||||
@@ -1,5 +1,7 @@
|
|||||||
/*!
|
/*!
|
||||||
\class BMidiLocalProducer MidiProducer.h
|
\class BMidiLocalProducer MidiProducer.h
|
||||||
|
\ingroup midi2
|
||||||
|
\ingroup libmidi2
|
||||||
\brief A producer endpoint that is created by your own application
|
\brief A producer endpoint that is created by your own application
|
||||||
|
|
||||||
You create a BMidiLocalProducer if you want your application to send MIDI
|
You create a BMidiLocalProducer if you want your application to send MIDI
|
||||||
|
|||||||
@@ -1,5 +1,7 @@
|
|||||||
/*!
|
/*!
|
||||||
\class BMidiProducer MidiProducer.h
|
\class BMidiProducer MidiProducer.h
|
||||||
|
\ingroup midi2
|
||||||
|
\ingroup libmidi2
|
||||||
\brief Streams MIDI events to connected consumers
|
\brief Streams MIDI events to connected consumers
|
||||||
|
|
||||||
A producer is an object that generate a stream of MIDI events. Each producer
|
A producer is an object that generate a stream of MIDI events. Each producer
|
||||||
|
|||||||
@@ -1,5 +1,7 @@
|
|||||||
/*!
|
/*!
|
||||||
\class BMidiRoster MidiRoster.h
|
\class BMidiRoster MidiRoster.h
|
||||||
|
\ingroup midi2
|
||||||
|
\ingroup libmidi2
|
||||||
\brief Interface to the system-wide Midi Roster
|
\brief Interface to the system-wide Midi Roster
|
||||||
|
|
||||||
BMidiRoster allows you to find available MIDI consumer and producer objects.
|
BMidiRoster allows you to find available MIDI consumer and producer objects.
|
||||||
|
|||||||
@@ -1,4 +1,7 @@
|
|||||||
/** \file parsedate.h
|
/*!
|
||||||
|
\file parsedate.h
|
||||||
|
\ingroup support
|
||||||
|
\ingroup libroot
|
||||||
\brief date parsing functions
|
\brief date parsing functions
|
||||||
|
|
||||||
This is a set a functions for parsing date strings in various formats.
|
This is a set a functions for parsing date strings in various formats.
|
||||||
|
|||||||
@@ -1,12 +1,10 @@
|
|||||||
/** \page support The Support Kit
|
/*!
|
||||||
|
\ingroup support
|
||||||
|
\page supportintro The Support Kit
|
||||||
|
|
||||||
The Support Kit provides a handy set of functions and classes that you can
|
The Support Kit provides a handy set of functions and classes that you can
|
||||||
use in your applications. It is part of both, libbe.so and libroot.so - a
|
use in your applications.
|
||||||
clear distinction of where you'll find what is still to be written/created.
|
|
||||||
Documentation is avaible for the following parts:
|
|
||||||
|
|
||||||
- \ref parsedate.h Date parsing functions
|
|
||||||
- \ref syslog.h system logging capabilities
|
|
||||||
|
|
||||||
|
This section is still under construction.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|||||||
@@ -1,4 +1,7 @@
|
|||||||
/** \file syslog.h
|
/*!
|
||||||
|
\file syslog.h
|
||||||
|
\ingroup support
|
||||||
|
\ingroup libroot
|
||||||
\brief System logging capabilities
|
\brief System logging capabilities
|
||||||
|
|
||||||
The functions described here are interacting with the syslog_daemon, a server
|
The functions described here are interacting with the syslog_daemon, a server
|
||||||
@@ -6,30 +9,30 @@ that provides the system logging capabilities.
|
|||||||
The log can be found in /var/log/syslog.
|
The log can be found in /var/log/syslog.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/** \fn void closelog(void)
|
/*! \fn void closelog(void)
|
||||||
\brief Closes the current log session
|
\brief Closes the current log session
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/** \fn void openlog(const char *ident, int options, int facility)
|
/*! \fn void openlog(const char *ident, int options, int facility)
|
||||||
\brief Starts a log session, and sets some output options
|
\brief Starts a log session, and sets some output options
|
||||||
|
|
||||||
Like openlog_thread() this function defines the log session in thread context; the
|
Like openlog_thread() this function defines the log session in thread context; the
|
||||||
global options set by openlog_team() are not affected by this function.
|
global options set by openlog_team() are not affected by this function.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/** \fn int setlogmask(int priorityMask)
|
/*! \fn int setlogmask(int priorityMask)
|
||||||
\brief sets the logging priority mask
|
\brief sets the logging priority mask
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/** \fn void syslog(int priority, const char *message, ...)
|
/*! \fn void syslog(int priority, const char *message, ...)
|
||||||
\brief sends a message to the system log
|
\brief sends a message to the system log
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/** \fn void closelog_team(void)
|
/*! \fn void closelog_team(void)
|
||||||
\brief Closes the log
|
\brief Closes the log
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/** \fn void openlog_team(const char *ident, int logopt, int facility)
|
/*! \fn void openlog_team(const char *ident, int logopt, int facility)
|
||||||
\brief Starts a log session, and sets some output options
|
\brief Starts a log session, and sets some output options
|
||||||
|
|
||||||
This function defines the team-wide logging options. Thread local sessions
|
This function defines the team-wide logging options. Thread local sessions
|
||||||
@@ -37,26 +40,26 @@ started with openlog() or openlog_thread() will inherit the options of the
|
|||||||
global session.
|
global session.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/** \fn void log_team(int priority, const char *message, ...)
|
/*! \fn void log_team(int priority, const char *message, ...)
|
||||||
\brief sends a message to the system log
|
\brief sends a message to the system log
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/** \fn int setlogmask_team(int priorityMask)
|
/*! \fn int setlogmask_team(int priorityMask)
|
||||||
\brief sets the logging priority mask
|
\brief sets the logging priority mask
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/** \fn void closelog_thread(void)
|
/*! \fn void closelog_thread(void)
|
||||||
\brief Closes the log
|
\brief Closes the log
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/** \fn void openlog_thread(const char *ident, int logopt, int facility)
|
/*! \fn void openlog_thread(const char *ident, int logopt, int facility)
|
||||||
\brief Starts a log session, and sets some output options
|
\brief Starts a log session, and sets some output options
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/** \fn void log_thread(int priority, const char *message, ...)
|
/*! \fn void log_thread(int priority, const char *message, ...)
|
||||||
\brief sends a message to the system log
|
\brief sends a message to the system log
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/** \fn int setlogmask_thread(int priorityMask)
|
/*! \fn int setlogmask_thread(int priorityMask)
|
||||||
\brief sets the logging priority mask
|
\brief sets the logging priority mask
|
||||||
*/
|
*/
|
||||||
|
|||||||
Reference in New Issue
Block a user