Commit b81cb2bcd82ef7f8ed1172cf83e1301fb430e614

thiago-personal
Wed Mar 17 21:58:47 CET 2010

Tree SHA1: 072dc90
Parent SHA1: 00ada12 (Update Xine includes to use lowercase-p too)
raw diff | raw patch

Update Phonon documentation to say the headers are supposed to be in lowercase-p dirs too

Diff rendering mode:
inline
side by side


	34	34	{
	35	35	class AbstractAudioOutputPrivate;
	36	36
	37		/** \class AbstractAudioOutput abstractaudiooutput.h Phonon/AbstractAudioOutput
		37	/** \class AbstractAudioOutput abstractaudiooutput.h phonon/AbstractAudioOutput
	38	38	* Common base class for all audio outputs.
	39	39	*
	40	40	* \see AudioOutput


	39	39	class MediaObject;
	40	40	class AbstractMediaStreamPrivate;
	41	41
	42		/** \class AbstractMediaStream abstractmediastream.h Phonon/AbstractMediaStream
		42	/** \class AbstractMediaStream abstractmediastream.h phonon/AbstractMediaStream
	43	43	* \brief Base class for custom media data streams.
	44	44	*
	45	45	* Implement this class to provide a custom data stream to the backend. The class supports both, the


	45	45
	46	46	class AbstractVideoOutputPrivate;
	47	47
	48		/** \class AbstractVideoOutput abstractvideooutput.h Phonon/AbstractVideoOutput
		48	/** \class AbstractVideoOutput abstractvideooutput.h phonon/AbstractVideoOutput
	49	49	* \brief Common base class for all video outputs.
	50	50	*
	51	51	* \see VideoWidget


	35	35
	36	36	namespace Phonon
	37	37	{
	38		/** \class AddonInterface addoninterface.h Phonon/AddonInterface
		38	/** \class AddonInterface addoninterface.h phonon/AddonInterface
	39	39	* \short Interface for Menu, Chapter, Angle and Title/Track control.
	40	40	*
	41	41	* \author Matthias Kretz <kretz@kde.org>


	38	38	{
	39	39	class AudioOutputPrivate;
	40	40
	41		/** \class AudioOutput audiooutput.h Phonon/AudioOutput
		41	/** \class AudioOutput audiooutput.h phonon/AudioOutput
	42	42	* \short Class for audio output to the soundcard.
	43	43	*
	44	44	* Use this class to define the audio output.


	33	33
	34	34	namespace Phonon
	35	35	{
	36		/** \class AudioOutputInterface audiooutputinterface.h Phonon/AudioOutputInterface
		36	/** \class AudioOutputInterface audiooutputinterface.h phonon/AudioOutputInterface
	37	37	* \short Interface for AudioOutput objects
	38	38	*
	39	39	* The implementation can make use of the signals


	51	51	*/
	52	52	namespace BackendCapabilities
	53	53	{
	54		/** \class Notifier backendcapabilities.h Phonon/BackendCapabilities
		54	/** \class Notifier backendcapabilities.h phonon/BackendCapabilities
	55	55	* Notifications about backend capabilities.
	56	56	*
	57	57	* \ingroup BackendInformation


	37	37	namespace Phonon
	38	38	{
	39	39
	40		/** \class BackendInterface backendinterface.h Phonon/BackendInterface
		40	/** \class BackendInterface backendinterface.h phonon/BackendInterface
	41	41	* \short Main Backend class interface
	42	42	*
	43	43	* This interface defines the main factory of the backend. The createObject function creates all the


	42	42	class EffectParameter;
	43	43	class EffectPrivate;
	44	44
	45		/** \class Effect effect.h Phonon/Effect
		45	/** \class Effect effect.h phonon/Effect
	46	46	* \short Effects that can be inserted into a Path.
	47	47	* An effect is a special object which can perform
	48	48	* transformations on the specified path. Examples may include simple


	34	34	namespace Phonon
	35	35	{
	36	36	class EffectParameter;
	37		/** \class EffectInterface effectinterface.h Phonon/EffectInterface
		37	/** \class EffectInterface effectinterface.h phonon/EffectInterface
	38	38	* \short Interface for Effect objects
	39	39	*
	40	40	* \author Matthias Kretz <kretz@kde.org>


	39	39	class Effect;
	40	40	class EffectParameterPrivate;
	41	41
	42		/** \class EffectParameter effectparameter.h Phonon/EffectParameter
		42	/** \class EffectParameter effectparameter.h phonon/EffectParameter
	43	43	* \brief This class describes one parameter of an effect.
	44	44	*
	45	45	* \ingroup PhononEffects


	38	38
	39	39	class EffectWidgetPrivate;
	40	40
	41		/** \class EffectWidget effectwidget.h Phonon/EffectWidget
		41	/** \class EffectWidget effectwidget.h phonon/EffectWidget
	42	42	* \brief Widget to control the parameters of an Effect.
	43	43	*
	44	44	* \ingroup PhononWidgets


	35	35	class MediaObject;
	36	36	class AbstractMediaStream2Private;
	37	37
	38		/** \class AbstractMediaStream2 abstractmediastream2.h Phonon/AbstractMediaStream2
		38	/** \class AbstractMediaStream2 abstractmediastream2.h phonon/AbstractMediaStream2
	39	39	* \brief Base class for custom media data streams.
	40	40	*
	41	41	* Implement this class to provide a custom data stream to the backend. The class supports both, the


	28	28	class PacketPool;
	29	29
	30	30	struct PacketPrivate;
	31		/** \class Packet packetpool.h Phonon/Packet
		31	/** \class Packet packetpool.h phonon/Packet
	32	32	* \brief Class to access memory preallocated by PacketPool
	33	33	*
	34	34	* \note PacketPool and Packet are threadsafe.


	27	27
	28	28	class Packet;
	29	29	class PacketPoolPrivate;
	30		/** \class PacketPool packetpool.h Phonon/PacketPool
		30	/** \class PacketPool packetpool.h phonon/PacketPool
	31	31	* \brief Class to preallocate memory.
	32	32	*
	33	33	* \note PacketPool and Packet are threadsafe.


	39	39	class MediaControllerPrivate;
	40	40	class MediaObject;
	41	41
	42		/** \class MediaController mediacontroller.h Phonon/MediaController
		42	/** \class MediaController mediacontroller.h phonon/MediaController
	43	43	* \brief Controls optional features of a media file/device like title, chapter, angle.
	44	44	*
	45	45	* \ingroup Playback


	35	35	{
	36	36	class MediaObjectPrivate;
	37	37
	38		/** \class MediaObject mediaobject.h Phonon/MediaObject
		38	/** \class MediaObject mediaobject.h phonon/MediaObject
	39	39	* \short Interface for media playback of a given URL.
	40	40	*
	41	41	* This class is the most important class in %Phonon. Use it to open a media


	33	33	{
	34	34	class StreamInterface;
	35	35
	36		/** \class MediaObjectInterface mediaobjectinterface.h Phonon/MediaObjectInterface
		36	/** \class MediaObjectInterface mediaobjectinterface.h phonon/MediaObjectInterface
	37	37	* \short Backend interface for media sources.
	38	38	*
	39	39	* The backend implementation has to provide two signals, that are not defined


	41	41	class MediaSourcePrivate;
	42	42	class AbstractMediaStream;
	43	43
	44		/** \class MediaSource mediasource.h Phonon/MediaSource
		44	/** \class MediaSource mediasource.h phonon/MediaSource
	45	45	* Note that all constructors of this class are implicit, so that you can simply write
	46	46	* \code
	47	47	* MediaObject m;


	87	87	};
	88	88
	89	89	/** \internal
	90		* \class ObjectDescriptionData objectdescription.h Phonon/ObjectDescription
		90	* \class ObjectDescriptionData objectdescription.h phonon/ObjectDescription
	91	91	* \brief Data class for objects describing devices or features of the backend.
	92	92	*
	93	93	* \author Matthias Kretz <kretz@kde.org>
	…	…
	165	165
	166	166	template<ObjectDescriptionType T> class ObjectDescriptionModel;
	167	167
	168		/** \class ObjectDescription objectdescription.h Phonon/ObjectDescription
		168	/** \class ObjectDescription objectdescription.h phonon/ObjectDescription
	169	169	* \short Provides a tuple of enduser visible name and description.
	170	170	*
	171	171	* Some parts give the enduser choices, e.g. what source to capture audio from.


	52	52	class ObjectDescriptionModelDataPrivate;
	53	53
	54	54	/** \internal
	55		* \class ObjectDescriptionModelData objectdescriptionmodel.h Phonon/ObjectDescriptionModelData
		55	* \class ObjectDescriptionModelData objectdescriptionmodel.h phonon/ObjectDescriptionModelData
	56	56	* \brief Data class for models for ObjectDescription objects.
	57	57	*
	58	58	* \author Matthias Kretz <kretz@kde.org>
	…	…
	151	151	ObjectDescriptionModelDataPrivate *const d;
	152	152	};
	153	153
	154		/** \class ObjectDescriptionModel objectdescriptionmodel.h Phonon/ObjectDescriptionModel
		154	/** \class ObjectDescriptionModel objectdescriptionmodel.h phonon/ObjectDescriptionModel
	155	155	* \short The ObjectDescriptionModel class provides a model from
	156	156	* a list of ObjectDescription objects.
	157	157	*


	40	40	class Effect;
	41	41	class MediaNode;
	42	42
	43		/** \class Path path.h Phonon/Path
		43	/** \class Path path.h phonon/Path
	44	44	* \short Connection object providing convenient effect insertion
	45	45	*
	46	46	* \code


	39	39
	40	40	class SeekSliderPrivate;
	41	41
	42		/** \class SeekSlider seekslider.h Phonon/SeekSlider
		42	/** \class SeekSlider seekslider.h phonon/SeekSlider
	43	43	* \short Widget providing a slider for seeking in MediaObject objects.
	44	44	*
	45	45	* \ingroup PhononWidgets


	36	36	class StreamInterfacePrivate;
	37	37	class MediaSource;
	38	38
	39		/** \class StreamInterface streaminterface.h Phonon/StreamInterface
		39	/** \class StreamInterface streaminterface.h phonon/StreamInterface
	40	40	* \brief Backend interface to handle media streams (AbstractMediaStream).
	41	41	*
	42	42	* \author Matthias Kretz <kretz@kde.org>


	32	32	namespace Phonon
	33	33	{
	34	34
	35		/** \class SwiftSlider swiftslider_p.h Phonon/SwiftSlider
		35	/** \class SwiftSlider swiftslider_p.h phonon/SwiftSlider
	36	36	* \short Modified QSlider that allows sudden/quick moves instead of stepped moves ("Click'n'Go" QSlider)
	37	37	*
	38	38	* This is an internal class used by SeekSlider and VolumeSlider.


	40	40	class AudioOutput;
	41	41	class VideoWidget;
	42	42
	43		/** \class VideoPlayer videoplayer.h Phonon/VideoPlayer
		43	/** \class VideoPlayer videoplayer.h phonon/VideoPlayer
	44	44	* \short Playback class for simple tasks.
	45	45	*
	46	46	* With %VideoPlayer you can get results quickly and easily. You can do the standard


	38	38	{
	39	39	class AbstractVideoOutput;
	40	40	class VideoWidgetPrivate;
	41		/** \class VideoWidget videowidget.h Phonon/VideoWidget
		41	/** \class VideoWidget videowidget.h phonon/VideoWidget
	42	42	* \short Widget to display video.
	43	43	*
	44	44	* This widget shows the video signal.


	35	35	{
	36	36	class VolumeFaderEffectPrivate;
	37	37
	38		/** \class VolumeFaderEffect volumefadereffect.h Phonon/VolumeFaderEffect
		38	/** \class VolumeFaderEffect volumefadereffect.h phonon/VolumeFaderEffect
	39	39	* Audio effect to gradually fade the audio volume.
	40	40	*
	41	41	* This effect differs from gradually changing the output volume in that


	37	37	class AudioOutput;
	38	38	class VolumeSliderPrivate;
	39	39
	40		/** \class VolumeSlider volumeslider.h Phonon/VolumeSlider
		40	/** \class VolumeSlider volumeslider.h phonon/VolumeSlider
	41	41	* \short Widget providing a slider to control the volume of an AudioOutput.
	42	42	*
	43	43	* \ingroup PhononWidgets