adam
/
darkice
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

fixed API documentation issues

This commit is contained in:
darkeye 2005-04-14 11:53:17 +00:00
parent 85868cc504
commit e8fa2eebd9
10 changed files with 54 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
darkice/trunk/src/AlsaDspSource.h
View File

@ -155,7 +155,7 @@ class AlsaDspSource : public AudioSource, public virtual Reporter
/**
* Copy Constructor.
*
* @param source the object to copy.
* @param ds the object to copy.
* @exception Exception
*/
inline
@ -301,6 +301,9 @@ class AlsaDspSource : public AudioSource, public virtual Reporter
$Source$
$Log$
Revision 1.2 2005/04/14 11:53:17 darkeye
fixed API documentation issues
Revision 1.1 2004/02/15 12:06:29 darkeye
added ALSA support, thanks to Christian Forster

7
darkice/trunk/src/AudioSource.h
View File

@ -162,7 +162,7 @@ class AudioSource : public Source, public virtual Reporter
/**
* Copy Constructor.
*
* @param source the object to copy.
* @param as the object to copy.
* @exception Exception
*/
inline
@ -258,7 +258,7 @@ class AudioSource : public Source, public virtual Reporter
* appropriate type, based on the compiled DSP support and
* the supplied DSP name parameter.
*
* @param name the audio device (/dev/dspX, hwplug:0,0, etc)
* @param deviceName the audio device (/dev/dspX, hwplug:0,0, etc)
* @param sampleRate samples per second (e.g. 44100 for 44.1kHz).
* @param bitsPerSample bits per sample (e.g. 16 bits).
* @param channel number of channels of the audio source
@ -307,6 +307,9 @@ class AudioSource : public Source, public virtual Reporter
$Source$
$Log$
Revision 1.9 2005/04/14 11:53:17 darkeye
fixed API documentation issues
Revision 1.8 2005/04/04 08:36:16 darkeye
commited changes to enable Jack support
thanks to Nicholas J. Humfrey, njh@ecs.soton.ac.uk

5
darkice/trunk/src/DarkIceConfig.h
View File

@ -179,7 +179,7 @@ class Config : public virtual Referable
/**
* Read a line of confiugration information.
*
* @param line the line to read.
* @param is the input stream to read from
* @return true if the line was correct, false otherwise.
* @exception Exception
*/
@ -213,6 +213,9 @@ class Config : public virtual Referable
$Source$
$Log$
Revision 1.2 2005/04/14 11:53:17 darkeye
fixed API documentation issues
Revision 1.1 2005/04/04 08:36:17 darkeye
commited changes to enable Jack support
thanks to Nicholas J. Humfrey, njh@ecs.soton.ac.uk

5
darkice/trunk/src/IceCast.h
View File

@ -136,6 +136,8 @@ class IceCast : public CastSink
* @param genre genre of the stream.
* @param bitRate bitrate of the stream (e.g. mp3 bitrate).
* @param isPublic is the stream public?
* @param streamDump an optional sink to dump the binary stream
* data to.
* @param bufferDuration duration of the BufferedSink buffer
* in seconds.
* @exception Exception
@ -263,6 +265,9 @@ class IceCast : public CastSink
$Source$
$Log$
Revision 1.8 2005/04/14 11:53:17 darkeye
fixed API documentation issues
Revision 1.7 2002/02/20 11:54:11 darkeye
added local dump file possibility

6
darkice/trunk/src/IceCast2.h
View File

@ -137,12 +137,15 @@ class IceCast2 : public CastSink
* @param socket socket connection to the server.
* @param password password to the server.
* @param mountPoint mount point of the stream on the server.
* @param format the format of the stream.
* @param name name of the stream.
* @param description description of the stream.
* @param url URL associated with the stream.
* @param genre genre of the stream.
* @param bitRate bitrate of the stream (e.g. mp3 bitrate).
* @param isPublic is the stream public?
* @param streamDump an optional sink to dump the binary stream
* data to.
* @param bufferDuration duration of the BufferedSink buffer
* in seconds.
* @exception Exception
@ -270,6 +273,9 @@ class IceCast2 : public CastSink
$Source$
$Log$
Revision 1.4 2005/04/14 11:53:17 darkeye
fixed API documentation issues
Revision 1.3 2002/02/20 11:54:11 darkeye
added local dump file possibility

9
darkice/trunk/src/JackDspSource.h
View File

@ -167,12 +167,12 @@ class JackDspSource : public AudioSource, public virtual Reporter
/**
* Copy Constructor.
*
* @param source the object to copy.
* @param jds the object to copy.
* @exception Exception
*/
inline
JackDspSource ( const JackDspSource & ds ) throw ( Exception )
: AudioSource( ds )
JackDspSource ( const JackDspSource & jds ) throw ( Exception )
: AudioSource( jds )
{
throw Exception( __FILE__, __LINE__, "JackDspSource doesn't copy");
}
@ -280,6 +280,9 @@ class JackDspSource : public AudioSource, public virtual Reporter
$Source$
$Log$
Revision 1.2 2005/04/14 11:53:17 darkeye
fixed API documentation issues
Revision 1.1 2005/04/04 08:36:17 darkeye
commited changes to enable Jack support
thanks to Nicholas J. Humfrey, njh@ecs.soton.ac.uk

11
darkice/trunk/src/OssDspSource.h
View File

@ -134,14 +134,14 @@ class OssDspSource : public AudioSource, public virtual Reporter
/**
* Copy Constructor.
*
* @param source the object to copy.
* @param ods the object to copy.
* @exception Exception
*/
inline
OssDspSource ( const OssDspSource & ds ) throw ( Exception )
: AudioSource( ds )
OssDspSource ( const OssDspSource & ods ) throw ( Exception )
: AudioSource( ods )
{
init( ds.fileName);
init( ods.fileName);
}
/**
@ -259,6 +259,9 @@ class OssDspSource : public AudioSource, public virtual Reporter
$Source$
$Log$
Revision 1.7 2005/04/14 11:53:17 darkeye
fixed API documentation issues
Revision 1.6 2002/12/20 10:40:40 darkeye
added support for big endian OSS devices (like Linux PowerPC)

5
darkice/trunk/src/ShoutCast.h
View File

@ -136,6 +136,8 @@ class ShoutCast : public CastSink
* @param irc IRC info string for the stream.
* @param aim AIM info string for the stream.
* @param icq ICQ info string for the stream.
* @param streamDump an optional sink to dump the binary stream
* data to.
* @param bufferDuration duration of the BufferedSink buffer
* in seconds.
* @exception Exception
@ -259,6 +261,9 @@ class ShoutCast : public CastSink
$Source$
$Log$
Revision 1.3 2005/04/14 11:53:17 darkeye
fixed API documentation issues
Revision 1.2 2002/02/20 11:54:11 darkeye
added local dump file possibility

11
darkice/trunk/src/SolarisDspSource.h
View File

@ -128,15 +128,15 @@ class SolarisDspSource : public AudioSource, public virtual Reporter
/**
* Copy Constructor.
*
* @param source the object to copy.
* @param sds the object to copy.
* @exception Exception
*/
inline
SolarisDspSource ( const SolarisDspSource & ds )
SolarisDspSource ( const SolarisDspSource & sds )
throw ( Exception )
: AudioSource( ds )
: AudioSource( sds )
{
init( ds.fileName);
init( sds.fileName);
}
/**
@ -261,6 +261,9 @@ class SolarisDspSource : public AudioSource, public virtual Reporter
$Source$
$Log$
Revision 1.5 2005/04/14 11:53:17 darkeye
fixed API documentation issues
Revision 1.4 2004/02/19 06:47:06 darkeye
finalized OpenBSD port

7
darkice/trunk/src/Util.h
View File

@ -138,7 +138,7 @@ class Util
*
* @param dest place for the copy. Storage size must be at least
* Util::strLen(src) + 1 long.
* @param str the string to copy.
* @param src the string to copy.
* @exception Exception
*/
static void
@ -151,7 +151,7 @@ class Util
* @param dest the string to concatenate to.
* Storage size of dest must be at least
* Util::strLen(dest) + Util::strLen(src) + 1 long.
* @param str the string to concatenate.
* @param src the string to concatenate.
* @exception Exception
*/
static void
@ -322,6 +322,9 @@ class Util
$Source$
$Log$
Revision 1.11 2005/04/14 11:53:17 darkeye
fixed API documentation issues
Revision 1.10 2004/02/15 12:06:30 darkeye
added ALSA support, thanks to Christian Forster