Aren/haiku
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

drop class names in docs

Browse Source 
various style fixes


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@18832 a95241bf-73f2-0310-859d-f6bbb57e9c96
This commit is contained in:
Jérôme Duval 2006-09-14 10:04:11 +00:00
parent d0641c6210
commit d655064c93
8 changed files with 103 additions and 105 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
headers/os/midi2/MidiProducer.h
View File

@ -23,7 +23,7 @@ private:
friend class BMidiRoster; friend class BMidiRoster;
friend class BPrivate::BMidiRosterLooper; friend class BPrivate::BMidiRosterLooper;
BMidiProducer(const char* name = NULL); BMidiProducer(const char *name = NULL);
virtual ~BMidiProducer(); virtual ~BMidiProducer();
virtual void _Reserved1(); virtual void _Reserved1();
@ -35,12 +35,12 @@ private:
virtual void _Reserved7(); virtual void _Reserved7();
virtual void _Reserved8(); virtual void _Reserved8();
status_t SendConnectRequest(BMidiConsumer*, bool); status_t SendConnectRequest(BMidiConsumer *, bool);
void ConnectionMade(BMidiConsumer*); void ConnectionMade(BMidiConsumer *);
bool ConnectionBroken(BMidiConsumer*); bool ConnectionBroken(BMidiConsumer *);
int32 CountConsumers() const; int32 CountConsumers() const;
BMidiConsumer* ConsumerAt(int32) const; BMidiConsumer *ConsumerAt(int32) const;
bool LockProducer() const; bool LockProducer() const;
void UnlockProducer() const; void UnlockProducer() const;
@ -61,7 +61,7 @@ public:
virtual void Disconnected(BMidiConsumer *cons); virtual void Disconnected(BMidiConsumer *cons);
void SprayData( void SprayData(
void* data, size_t length, bool atomic = false, void *data, size_t length, bool atomic = false,
bigtime_t time = 0) const; bigtime_t time = 0) const;
void SprayNoteOff( void SprayNoteOff(
@ -90,7 +90,7 @@ public:
uchar channel, uchar lsb, uchar msb, bigtime_t time = 0) const; uchar channel, uchar lsb, uchar msb, bigtime_t time = 0) const;
void SpraySystemExclusive( void SpraySystemExclusive(
void* data, size_t length, bigtime_t time = 0) const; void *data, size_t length, bigtime_t time = 0) const;
void SpraySystemCommon( void SpraySystemCommon(
uchar status, uchar data1, uchar data2, bigtime_t time = 0) const; uchar status, uchar data1, uchar data2, bigtime_t time = 0) const;
@ -108,7 +108,7 @@ protected:
private: private:
void SprayEvent( void SprayEvent(
const void* data, size_t length, bool atomic, bigtime_t time, const void *data, size_t length, bool atomic, bigtime_t time,
bool sysex = false) const; bool sysex = false) const;
virtual void _Reserved1(); virtual void _Reserved1();

20
headers/os/midi2/MidiRoster.h
View File

@ -32,21 +32,21 @@ class BMidiRoster
{ {
public: public:
static BMidiEndpoint* NextEndpoint(int32* id); static BMidiEndpoint *NextEndpoint(int32 *id);
static BMidiProducer* NextProducer(int32* id); static BMidiProducer *NextProducer(int32 *id);
static BMidiConsumer* NextConsumer(int32* id); static BMidiConsumer *NextConsumer(int32 *id);
static BMidiEndpoint* FindEndpoint(int32 id, bool localOnly = false); static BMidiEndpoint *FindEndpoint(int32 id, bool localOnly = false);
static BMidiProducer* FindProducer(int32 id, bool localOnly = false); static BMidiProducer *FindProducer(int32 id, bool localOnly = false);
static BMidiConsumer* FindConsumer(int32 id, bool localOnly = false); static BMidiConsumer *FindConsumer(int32 id, bool localOnly = false);
static void StartWatching(const BMessenger* msngr); static void StartWatching(const BMessenger *msngr);
static void StopWatching(); static void StopWatching();
static status_t Register(BMidiEndpoint* endp); static status_t Register(BMidiEndpoint *endp);
static status_t Unregister(BMidiEndpoint* endp); static status_t Unregister(BMidiEndpoint *endp);
static BMidiRoster* MidiRoster(); static BMidiRoster *MidiRoster();
private: private:

2
src/documentation/haiku_book/midi/midi2consumer.xml
View File

@ -16,7 +16,7 @@
</para> </para>
<sect3 id="BMidiConsumer_Latency"> <sect3 id="BMidiConsumer_Latency">
<title>bigtime_t BMidiConsumer::Latency() const</title> <title>bigtime_t Latency() const</title>
<para> <para>
The latency is measured in microseconds. Producers should attempt to get MIDI The latency is measured in microseconds. Producers should attempt to get MIDI

30
src/documentation/haiku_book/midi/midi2endpoint.xml
View File

@ -26,7 +26,7 @@
</para> </para>
<sect3 id="bmidiendpoint_name"> <sect3 id="bmidiendpoint_name">
<title>const char* BMidiEndpoint::Name() const</title> <title>const char* Name() const</title>
<para> <para>
Returns the name of the endpoint. Returns the name of the endpoint.
@ -44,7 +44,7 @@
</sect3> </sect3>
<sect3 id="bmidiendpoint_setname"> <sect3 id="bmidiendpoint_setname">
<title>void BMidiEndpoint::SetName(const char* name)</title> <title>void SetName(const char* name)</title>
<para> <para>
Changes the name of the endpoint. Changes the name of the endpoint.
@ -73,7 +73,7 @@
</sect3> </sect3>
<sect3 id="bmidiendpoint_id"> <sect3 id="bmidiendpoint_id">
<title>int32 BMidiEndpoint::ID() const</title> <title>int32 ID() const</title>
<para> <para>
Returns the ID of the endpoint Returns the ID of the endpoint
@ -89,7 +89,7 @@
</sect3> </sect3>
<sect3 id="bmidiendpoint_isproducer"> <sect3 id="bmidiendpoint_isproducer">
<title>bool BMidiEndpoint::IsProducer() const</title> <title>bool IsProducer() const</title>
<para> <para>
Determines whether this endpoint is a BMidiProducer Determines whether this endpoint is a BMidiProducer
@ -109,7 +109,7 @@
</sect3> </sect3>
<sect3 id="bmidiendpoint_isconsumer"> <sect3 id="bmidiendpoint_isconsumer">
<title>bool BMidiEndpoint::IsConsumer() const</title> <title>bool IsConsumer() const</title>
<para> <para>
Determines whether this endpoint is a BMidiConsumer Determines whether this endpoint is a BMidiConsumer
@ -128,7 +128,7 @@
</sect3> </sect3>
<sect3 id="bmidiendpoint_isremote"> <sect3 id="bmidiendpoint_isremote">
<title>bool BMidiEndpoint::IsRemote() const</title> <title>bool IsRemote() const</title>
<para> <para>
Determines whether this endpoint is a proxy for a remote object. Determines whether this endpoint is a proxy for a remote object.
@ -142,7 +142,7 @@
</sect3> </sect3>
<sect3 id="bmidiendpoint_islocal"> <sect3 id="bmidiendpoint_islocal">
<title>bool BMidiEndpoint::IsLocal() const</title> <title>bool IsLocal() const</title>
<para> <para>
Determines whether this endpoint represents a local object Determines whether this endpoint represents a local object
@ -155,7 +155,7 @@
</sect3> </sect3>
<sect3 id="bmidiendpoint_ispersistent"> <sect3 id="bmidiendpoint_ispersistent">
<title>bool BMidiEndpoint::IsPersistent() const</title> <title>bool IsPersistent() const</title>
<para> <para>
Not used Not used
@ -172,7 +172,7 @@
</sect3> </sect3>
<sect3 id="bmidiendpoint_isvalid"> <sect3 id="bmidiendpoint_isvalid">
<title>bool BMidiEndpoint::IsValid() const</title> <title>bool IsValid() const</title>
<para> <para>
Determines whether the endpoint still exists Determines whether the endpoint still exists
@ -203,7 +203,7 @@
</sect3> </sect3>
<sect3 id="bmidiendpoint_acquire"> <sect3 id="bmidiendpoint_acquire">
<title>status_t BMidiEndpoint::Acquire()</title> <title>status_t Acquire()</title>
<para> <para>
Increments the endpoint's reference count Increments the endpoint's reference count
@ -252,7 +252,7 @@
</sect3> </sect3>
<sect3 id="bmidiendpoint_release"> <sect3 id="bmidiendpoint_release">
<title>status_t BMidiEndpoint::Release()</title> <title>status_t Release()</title>
<para> <para>
Decrements the endpoint's reference count Decrements the endpoint's reference count
@ -268,7 +268,7 @@
</sect3> </sect3>
<sect3 id="bmidiendpoint_register"> <sect3 id="bmidiendpoint_register">
<title>status_t BMidiEndpoint::Register()</title> <title>status_t Register()</title>
<para> <para>
Publishes the endpoint on the roster Publishes the endpoint on the roster
@ -317,7 +317,7 @@
</sect3> </sect3>
<sect3 id="bmidiendpoint_unregister"> <sect3 id="bmidiendpoint_unregister">
<title>status_t BMidiEndpoint::Unregister()</title> <title>status_t Unregister()</title>
<para> <para>
Hides the endpoint from the roster Hides the endpoint from the roster
@ -329,7 +329,7 @@
</sect3> </sect3>
<sect3 id="bmidiendpoint_setproperties"> <sect3 id="bmidiendpoint_setproperties">
<title>status_t BMidiEndpoint::SetProperties(const BMessage* properties)</title> <title>status_t SetProperties(const BMessage* properties)</title>
<para> <para>
Changes the properties of the endpoint Changes the properties of the endpoint
@ -423,7 +423,7 @@
</sect3> </sect3>
<sect3 id="bmidiendpoint_getproperties"> <sect3 id="bmidiendpoint_getproperties">
<title>status_t BMidiEndpoint::GetProperties(BMessage* properties) const</title> <title>status_t GetProperties(BMessage* properties) const</title>
<para> <para>
Reads the properties of the endpoint Reads the properties of the endpoint

39
src/documentation/haiku_book/midi/midi2localconsumer.xml
View File

@ -46,7 +46,7 @@
</para> </para>
<sect3 id="bmidilocalconsumer_bmidilocalconsumer"> <sect3 id="bmidilocalconsumer_bmidilocalconsumer">
<title>BMidiLocalConsumer::BMidiLocalConsumer(const char *name = NULL)</title> <title>BMidiLocalConsumer(const char *name = NULL)</title>
<para> <para>
Creates a new local consumer endpoint. Creates a new local consumer endpoint.
@ -82,7 +82,7 @@
</sect3> </sect3>
<sect3 id="bmidilocalconsumer_setlatency"> <sect3 id="bmidilocalconsumer_setlatency">
<title>void BMidiLocalConsumer::SetLatency(bigtime_t latency)</title> <title>void SetLatency(bigtime_t latency)</title>
<para> <para>
Changes the published latency of the consumer. Changes the published latency of the consumer.
@ -91,7 +91,7 @@
</sect3> </sect3>
<sect3 id="bmidilocalconsumer_getproducerid"> <sect3 id="bmidilocalconsumer_getproducerid">
<title>int32 BMidiLocalConsumer::GetProducerID()</title> <title>int32 GetProducerID()</title>
<para> <para>
Returns the ID of the producer that most recently sent a MIDI event to Returns the ID of the producer that most recently sent a MIDI event to
@ -105,7 +105,7 @@
</sect3> </sect3>
<sect3 id="bmidilocalconsumer_settimeout"> <sect3 id="bmidilocalconsumer_settimeout">
<title>void BMidiLocalConsumer::SetTimeout(bigtime_t when, void *data)</title> <title>void SetTimeout(bigtime_t when, void *data)</title>
<para> <para>
Requests that the Timeout() hook will be called at some point Requests that the Timeout() hook will be called at some point
@ -146,7 +146,7 @@
</sect3> </sect3>
<sect3 id="bmidilocalconsumer_timeout"> <sect3 id="bmidilocalconsumer_timeout">
<title>virtual void BMidiLocalConsumer::Timeout(void *data)</title> <title>virtual void Timeout(void *data)</title>
<para> <para>
Hook function that is called per your own request. Hook function that is called per your own request.
@ -158,7 +158,7 @@
</sect3> </sect3>
<sect3 id="bmidilocalconsumer_data"> <sect3 id="bmidilocalconsumer_data">
<title>virtual void BMidiLocalConsumer::Data( <title>virtual void Data(
uchar *data, size_t length, bool atomic, bigtime_t time)</title> uchar *data, size_t length, bool atomic, bigtime_t time)</title>
<para> <para>
@ -205,7 +205,7 @@
</sect3> </sect3>
<sect3 id="bmidilocalconsumer_noteoff"> <sect3 id="bmidilocalconsumer_noteoff">
<title>virtual void BMidiLocalConsumer::NoteOff( <title>virtual void NoteOff(
uchar channel, uchar note, uchar velocity, bigtime_t time)</title> uchar channel, uchar note, uchar velocity, bigtime_t time)</title>
<para> <para>
@ -218,7 +218,7 @@
</sect3> </sect3>
<sect3 id="bmidilocalconsumer_noteon"> <sect3 id="bmidilocalconsumer_noteon">
<title>virtual void BMidiLocalConsumer::NoteOn( <title>virtual void NoteOn(
uchar channel, uchar note, uchar velocity, bigtime_t time)</title> uchar channel, uchar note, uchar velocity, bigtime_t time)</title>
<para> <para>
@ -231,7 +231,7 @@
</sect3> </sect3>
<sect3 id="bmidilocalconsumer_keypressure"> <sect3 id="bmidilocalconsumer_keypressure">
<title>virtual void BMidiLocalConsumer::KeyPressure( <title>virtual void KeyPressure(
uchar channel, uchar note, uchar pressure, bigtime_t time)</title> uchar channel, uchar note, uchar pressure, bigtime_t time)</title>
<para> <para>
@ -244,7 +244,7 @@
</sect3> </sect3>
<sect3 id="bmidilocalconsumer_controlchange"> <sect3 id="bmidilocalconsumer_controlchange">
<title>virtual void BMidiLocalConsumer::ControlChange( <title>virtual void ControlChange(
uchar channel, uchar controlNumber, uchar controlValue, bigtime_t time)</title> uchar channel, uchar controlNumber, uchar controlValue, bigtime_t time)</title>
<para> <para>
@ -257,7 +257,7 @@
</sect3> </sect3>
<sect3 id="bmidilocalconsumer_programchange"> <sect3 id="bmidilocalconsumer_programchange">
<title>virtual void BMidiLocalConsumer::ProgramChange( <title>virtual void ProgramChange(
uchar channel, uchar programNumber, bigtime_t time)</title> uchar channel, uchar programNumber, bigtime_t time)</title>
<para> <para>
@ -270,7 +270,7 @@
</sect3> </sect3>
<sect3 id="bmidilocalconsumer_channelpressure"> <sect3 id="bmidilocalconsumer_channelpressure">
<title>virtual void BMidiLocalConsumer::ChannelPressure( <title>virtual void ChannelPressure(
uchar channel, uchar pressure, bigtime_t time)</title> uchar channel, uchar pressure, bigtime_t time)</title>
<para> <para>
@ -283,7 +283,7 @@
</sect3> </sect3>
<sect3 id="bmidilocalconsumer_pitchbend"> <sect3 id="bmidilocalconsumer_pitchbend">
<title>virtual void BMidiLocalConsumer::PitchBend( <title>virtual void PitchBend(
uchar channel, uchar lsb, uchar msb, bigtime_t time)</title> uchar channel, uchar lsb, uchar msb, bigtime_t time)</title>
<para> <para>
@ -296,9 +296,8 @@
</sect3> </sect3>
<sect3 id="bmidilocalconsumer_systemexclusive"> <sect3 id="bmidilocalconsumer_systemexclusive">
<title>virtual void BMidiLocalConsumer::SystemExclusive( <title>virtual void SystemExclusive(
void* data, size_t length, bigtime_t time) void* data, size_t length, bigtime_t time)</title>
</title>
<para> <para>
Invoked when a System Exclusive event is received Invoked when a System Exclusive event is received
@ -320,7 +319,7 @@
</sect3> </sect3>
<sect3 id="bmidilocalconsumer_systemcommon"> <sect3 id="bmidilocalconsumer_systemcommon">
<title>virtual void BMidiLocalConsumer::SystemCommon( <title>virtual void SystemCommon(
uchar status, uchar data1, uchar data2, bigtime_t time)</title> uchar status, uchar data1, uchar data2, bigtime_t time)</title>
<para> <para>
@ -337,7 +336,7 @@
</sect3> </sect3>
<sect3 id="bmidilocalconsumer_systemrealtime"> <sect3 id="bmidilocalconsumer_systemrealtime">
<title>virtual void BMidiLocalConsumer::SystemRealTime( <title>virtual void SystemRealTime(
uchar status, bigtime_t time)</title> uchar status, bigtime_t time)</title>
<para> <para>
@ -350,7 +349,7 @@
</sect3> </sect3>
<sect3 id="bmidilocalconsumer_tempochange"> <sect3 id="bmidilocalconsumer_tempochange">
<title>virtual void BMidiLocalConsumer::TempoChange(int32 beatsPerMinute, bigtime_t time)</title> <title>virtual void TempoChange(int32 beatsPerMinute, bigtime_t time)</title>
<para> <para>
Invoked when a Tempo Change event is received Invoked when a Tempo Change event is received
@ -362,7 +361,7 @@
</sect3> </sect3>
<sect3 id="bmidilocalconsumer_allnotesoff"> <sect3 id="bmidilocalconsumer_allnotesoff">
<title>virtual void BMidiLocalConsumer::AllNotesOff(bool justChannel, bigtime_t time)</title> <title>virtual void AllNotesOff(bool justChannel, bigtime_t time)</title>
<para> <para>
Not used Not used

45
src/documentation/haiku_book/midi/midi2localproducer.xml
View File

@ -34,7 +34,7 @@
</para> </para>
<sect3 id="bmidilocalproducer_bmidilocalproducer"> <sect3 id="bmidilocalproducer_bmidilocalproducer">
<title>BMidiLocalProducer::BMidiLocalProducer(const char *name = NULL)</title> <title>BMidiLocalProducer(const char *name = NULL)</title>
<para> <para>
Creates a new local producer endpoint. Creates a new local producer endpoint.
@ -70,7 +70,7 @@
</sect3> </sect3>
<sect3 id="bmidilocalproducer_connected"> <sect3 id="bmidilocalproducer_connected">
<title>virtual void BMidiLocalProducer::Connected(BMidiConsumer *cons)</title> <title>virtual void Connected(BMidiConsumer *cons)</title>
<para> <para>
Invoked when a new consumer is connected to this producer Invoked when a new consumer is connected to this producer
@ -100,7 +100,7 @@
</sect3> </sect3>
<sect3 id="bmidilocalproducer_disconnected"> <sect3 id="bmidilocalproducer_disconnected">
<title>virtual void BMidiLocalProducer::Disconnected(BMidiConsumer *cons)</title> <title>virtual void Disconnected(BMidiConsumer *cons)</title>
<para> <para>
Invoked when a consumer is disconnected from this producer. Invoked when a consumer is disconnected from this producer.
@ -112,8 +112,8 @@
</sect3> </sect3>
<sect3 id="bmidilocalproducer_spraydata"> <sect3 id="bmidilocalproducer_spraydata">
<title>void BMidiLocalProducer::SprayData( <title>void SprayData(
void *data, size_t length, bool atomic = false, bigtime_t time = 0) const </title> void *data, size_t length, bool atomic = false, bigtime_t time = 0) const</title>
<para> <para>
Sends raw MIDI data downstream to all connected consumers Sends raw MIDI data downstream to all connected consumers
@ -149,7 +149,7 @@
</sect3> </sect3>
<sect3 id="bmidilocalproducer_spraynoteoff"> <sect3 id="bmidilocalproducer_spraynoteoff">
<title>void BMidiLocalProducer::SprayNoteOff( <title>void SprayNoteOff(
uchar channel, uchar note, uchar velocity, bigtime_t time = 0) const</title> uchar channel, uchar note, uchar velocity, bigtime_t time = 0) const</title>
<para> <para>
@ -162,7 +162,7 @@
</sect3> </sect3>
<sect3 id="bmidilocalproducer_spraynoteon"> <sect3 id="bmidilocalproducer_spraynoteon">
<title>void BMidiLocalProducer::SprayNoteOn( <title>void SprayNoteOn(
uchar channel, uchar note, uchar velocity, bigtime_t time = 0) const</title> uchar channel, uchar note, uchar velocity, bigtime_t time = 0) const</title>
<para> <para>
@ -175,7 +175,7 @@
</sect3> </sect3>
<sect3 id="bmidIlocalproducer_spraykeypressure"> <sect3 id="bmidIlocalproducer_spraykeypressure">
<title>void BMidiLocalProducer::SprayKeyPressure( <title>void SprayKeyPressure(
uchar channel, uchar note, uchar pressure, bigtime_t time = 0) const</title> uchar channel, uchar note, uchar pressure, bigtime_t time = 0) const</title>
<para> <para>
@ -189,9 +189,9 @@
</sect3> </sect3>
<sect3 id="bmidilocalproducer_spraycontrolchange"> <sect3 id="bmidilocalproducer_spraycontrolchange">
<title>void BMidiLocalProducer::SprayControlChange( <title>void SprayControlChange(
uchar channel, uchar controlNumber, uchar controlValue, uchar channel, uchar controlNumber, uchar controlValue,
bigtime_t time = 0) const </title> bigtime_t time = 0) const</title>
<para> <para>
Sends a Controller Change event to all connected consumers. Sends a Controller Change event to all connected consumers.
@ -204,8 +204,8 @@
</sect3> </sect3>
<sect3 id="bmidilocalproducer_sprayprogramchange"> <sect3 id="bmidilocalproducer_sprayprogramchange">
<title>BMidiLocalProducer::SprayProgramChange( <title>void SprayProgramChange(
uchar channel, uchar programNumber, bigtime_t time = 0) const </title> uchar channel, uchar programNumber, bigtime_t time = 0) const</title>
<para> <para>
Sends a Program Change event to all connected consumers Sends a Program Change event to all connected consumers
@ -217,8 +217,8 @@
</sect3> </sect3>
<sect3 id="bmidilocalproducer_spraychannelpressure"> <sect3 id="bmidilocalproducer_spraychannelpressure">
<title>void BMidiLocalProducer::SprayChannelPressure( <title>void SprayChannelPressure(
uchar channel, uchar pressure, bigtime_t time = 0) const </title> uchar channel, uchar pressure, bigtime_t time = 0) const</title>
<para> <para>
Sends a Channel Pressure event to all connected consumers Sends a Channel Pressure event to all connected consumers
@ -230,8 +230,8 @@
</sect3> </sect3>
<sect3 id="bmidilocalproducer_spraypitchbend"> <sect3 id="bmidilocalproducer_spraypitchbend">
<title>void BMidiLocalProducer::SprayPitchBend( <title>void SprayPitchBend(
uchar channel, uchar lsb, uchar msb, bigtime_t time = 0) const </title> uchar channel, uchar lsb, uchar msb, bigtime_t time = 0) const</title>
<para> <para>
Sends a Pitch Bend event to all connected consumers Sends a Pitch Bend event to all connected consumers
@ -243,9 +243,8 @@
</sect3> </sect3>
<sect3 id="bmidilocalproducer_spraysystemexclusive"> <sect3 id="bmidilocalproducer_spraysystemexclusive">
<title> <title>void SpraySystemExclusive(
void BMidiLocalProducer::SpraySystemExclusive( void *data, size_t length, bigtime_t time = 0) const</title>
void *data, size_t length, bigtime_t time = 0) const </title>
<para> <para>
Sends a System Exclusive event to all connected consumers Sends a System Exclusive event to all connected consumers
@ -264,7 +263,7 @@
</sect3> </sect3>
<sect3 id="bmidilocalproducer_spraysystemcommon"> <sect3 id="bmidilocalproducer_spraysystemcommon">
<title>void BMidiLocalProducer::SpraySystemCommon( <title>void SpraySystemCommon(
uchar status, uchar data1, uchar data2, bigtime_t time = 0) const</title> uchar status, uchar data1, uchar data2, bigtime_t time = 0) const</title>
<para> <para>
@ -322,7 +321,7 @@
</sect3> </sect3>
<sect3 id="bmidilocalproducer_spraysystemrealtime"> <sect3 id="bmidilocalproducer_spraysystemrealtime">
<title>void BMidiLocalProducer::SpraySystemRealTime( <title>void SpraySystemRealTime(
uchar status, bigtime_t time = 0) const</title> uchar status, bigtime_t time = 0) const</title>
<para> <para>
@ -383,8 +382,8 @@
</sect3> </sect3>
<sect3 id="bmidilocalproducer_spraytempochange"> <sect3 id="bmidilocalproducer_spraytempochange">
<title>void BMidiLocalProducer::SprayTempoChange( <title>void SprayTempoChange(
int32 bpm, bigtime_t time = 0) const </title> int32 beatsPerMinute, bigtime_t time = 0) const</title>
<para> <para>
Sends a Tempo Change event to the connected consumers. Sends a Tempo Change event to the connected consumers.
</para> </para>

8
src/documentation/haiku_book/midi/midi2producer.xml
View File

@ -20,7 +20,7 @@
</para> </para>
<sect3 id="bmidiproducer_connect"> <sect3 id="bmidiproducer_connect">
<title>status_t BMidiProducer::Connect(BMidiConsumer *cons)</title> <title>status_t Connect(BMidiConsumer *cons)</title>
<para> <para>
Connects a consumer to this producer Connects a consumer to this producer
@ -45,7 +45,7 @@
</sect3> </sect3>
<sect3 id="bmidiproducer_disconnect"> <sect3 id="bmidiproducer_disconnect">
<title>status_t BMidiProducer::Disconnect(BMidiConsumer *cons)</title> <title>status_t Disconnect(BMidiConsumer *cons)</title>
<para> <para>
Disconnects a consumer from this producer Disconnects a consumer from this producer
@ -67,7 +67,7 @@
</sect3> </sect3>
<sect3 id="bmidiproducer_isconnected"> <sect3 id="bmidiproducer_isconnected">
<title>bool BMidiProducer::IsConnected(BMidiConsumer *cons) const</title> <title>bool IsConnected(BMidiConsumer *cons) const</title>
<para> <para>
Determines whether a consumer is connected to this producer Determines whether a consumer is connected to this producer
@ -80,7 +80,7 @@
</sect3> </sect3>
<sect3 id="bmidiproducer_connections"> <sect3 id="bmidiproducer_connections">
<title>BList *BMidiProducer::Connections() const</title> <title>BList *Connections() const</title>
<para> <para>
Returns a list with all connected consumers Returns a list with all connected consumers

46
src/documentation/haiku_book/midi/midi2roster.xml
View File

@ -26,12 +26,12 @@
<para> <para>
You can call BMidiRoster's functions like this: You can call BMidiRoster's functions like this:
<programlisting> <programlisting>
producer = BMidiRoster::FindProducer(someID); producer = FindProducer(someID);
</programlisting> </programlisting>
Or using the slightly more annoying: Or using the slightly more annoying:
<programlisting> <programlisting>
BMidiRoster* roster = BMidiRoster::MidiRoster(); BMidiRoster *roster = MidiRoster();
if (roster != NULL) if (roster != NULL)
{ {
producer = roster->FindProducer(someID); producer = roster->FindProducer(someID);
@ -40,7 +40,7 @@
</para> </para>
<sect3 id="bmidiroster_nextendpoint"> <sect3 id="bmidiroster_nextendpoint">
<title>BMidiEndpoint* BMidiRoster::NextEndpoint(int32* id)</title> <title>static BMidiEndpoint *NextEndpoint(int32 *id)</title>
<para> <para>
Returns the next endpoint from the roster Returns the next endpoint from the roster
@ -61,8 +61,8 @@
Usage example: Usage example:
<programlisting> <programlisting>
int32 id = 0; int32 id = 0;
BMidiEndpoint* endp; BMidiEndpoint *endp;
while ((endp = BMidiRoster::NextEndpoint(&amp;id)) != NULL) while ((endp = NextEndpoint(&amp;id)) != NULL)
{ {
...do something with endpoint ... ...do something with endpoint ...
endp->Release(); // don't forget! endp->Release(); // don't forget!
@ -78,7 +78,7 @@
</sect3> </sect3>
<sect3 id="bmidiroster_nextproducer"> <sect3 id="bmidiroster_nextproducer">
<title>BMidiProducer* BMidiRoster::NextProducer(int32* id)</title> <title>static BMidiProducer *NextProducer(int32 *id)</title>
<para> <para>
Returns the next producer from the roster Returns the next producer from the roster
@ -95,7 +95,7 @@
</sect3> </sect3>
<sect3 id="bmidiroster_nextconsumer"> <sect3 id="bmidiroster_nextconsumer">
<title>BMidiConsumer* BMidiRoster::NextConsumer(int32* id)</title> <title>static BMidiConsumer *NextConsumer(int32 *id)</title>
<para> <para>
Returns the next consumer from the roster Returns the next consumer from the roster
@ -112,7 +112,7 @@
</sect3> </sect3>
<sect3 id="bmidiroster_findendpoint"> <sect3 id="bmidiroster_findendpoint">
<title>BMidiEndpoint* BMidiRoster::FindEndpoint( <title>static BMidiEndpoint *FindEndpoint(
int32 id, bool localOnly = false)</title> int32 id, bool localOnly = false)</title>
<para> <para>
@ -133,17 +133,17 @@
</para> </para>
<para><programlisting> <para><programlisting>
BMidiEndpoint* endp = ...; BMidiEndpoint *endp = ...;
BMidiProducer* prod = NULL; BMidiProducer *prod = NULL;
BMidiConsumer* cons = NULL; BMidiConsumer *cons = NULL;
if (endp->IsProducer()) if (endp->IsProducer())
{ {
prod = dynamic_cast&lt;BMidiProducer*&gt;(endp); prod = dynamic_cast&lt;BMidiProducer *&gt;(endp);
} }
else if (endp->IsConsumer()) else if (endp->IsConsumer())
{ {
cons = dynamic_cast&lt;BMidiConsumer*&gt;(endp); cons = dynamic_cast&lt;BMidiConsumer *&gt;(endp);
} }
</programlisting></para> </programlisting></para>
@ -152,7 +152,7 @@
should always \link BMidiEndpoint::Release() Release() \endlink an endpoint should always \link BMidiEndpoint::Release() Release() \endlink an endpoint
when you are done with it: when you are done with it:
<programlisting> <programlisting>
BMidiEndpoint* endp = BMidiRoster::FindEndpoint(someID); BMidiEndpoint *endp = FindEndpoint(someID);
if (endp != NULL) if (endp != NULL)
{ {
...do stuff with the endpoint... ...do stuff with the endpoint...
@ -163,7 +163,7 @@
</sect3> </sect3>
<sect3 id="bmidiroster_findproducer"> <sect3 id="bmidiroster_findproducer">
<title>BMidiProducer* BMidiRoster::FindProducer( <title>static BMidiProducer *FindProducer(
int32 id, bool localOnly = false)</title> int32 id, bool localOnly = false)</title>
<para> <para>
@ -182,7 +182,7 @@
</sect3> </sect3>
<sect3 id="bmidiroster_findconsumer"> <sect3 id="bmidiroster_findconsumer">
<title>BMidiConsumer* BMidiRoster::FindConsumer( <title>static BMidiConsumer *FindConsumer(
int32 id, bool localOnly = false)</title> int32 id, bool localOnly = false)</title>
<para> <para>
@ -201,7 +201,7 @@
</sect3> </sect3>
<sect3 id="bmidiroster_startwatching"> <sect3 id="bmidiroster_startwatching">
<title>void BMidiRoster::StartWatching(const BMessenger* msngr)</title> <title>static void StartWatching(const BMessenger *msngr)</title>
<para> <para>
Start receiving notifications from the Midi Roster Start receiving notifications from the Midi Roster
@ -464,10 +464,10 @@
void MyView::AttachedToWindow() void MyView::AttachedToWindow()
{ {
BMessenger msgr(this); BMessenger msgr(this);
BMidiRoster::StartWatching(&amp;msgr); StartWatching(&amp;msgr);
} }
void MyView::MessageReceived(BMessage* msg) void MyView::MessageReceived(BMessage *msg)
{ {
switch (msg->what) switch (msg->what)
{ {
@ -488,7 +488,7 @@
</sect3> </sect3>
<sect3 id="bmidiroster_stopwatching"> <sect3 id="bmidiroster_stopwatching">
<title>void BMidiRoster::StopWatching()</title> <title>static void StopWatching()</title>
<para> <para>
Stop receiving notifications from the Midi Roster Stop receiving notifications from the Midi Roster
@ -500,7 +500,7 @@
</sect3> </sect3>
<sect3 id="bmidiroster_register"> <sect3 id="bmidiroster_register">
<title>status_t BMidiRoster::Register(BMidiEndpoint* object)</title> <title>static status_t Register(BMidiEndpoint *endp)</title>
<para> <para>
Publishes an endpoint to other applications Publishes an endpoint to other applications
@ -513,7 +513,7 @@
</sect3> </sect3>
<sect3 id="bmidiroster_unregister"> <sect3 id="bmidiroster_unregister">
<title>status_t BMidiRoster::Unregister(BMidiEndpoint* object)</title> <title>static status_t Unregister(BMidiEndpoint *endp)</title>
<para> <para>
Hides an endpoint from other applications Hides an endpoint from other applications
@ -526,7 +526,7 @@
</sect3> </sect3>
<sect3 id="bmidiroster_midiroster"> <sect3 id="bmidiroster_midiroster">
<title>BMidiRoster* BMidiRoster::MidiRoster()</title> <title>static BMidiRoster *MidiRoster()</title>
<para> <para>
Returns a pointer to the only instance of BMidiRoster Returns a pointer to the only instance of BMidiRoster