From d655064c93c45b98f2073f3287e07b5283787834 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=B4me=20Duval?= Date: Thu, 14 Sep 2006 10:04:11 +0000 Subject: [PATCH] drop class names in docs various style fixes git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@18832 a95241bf-73f2-0310-859d-f6bbb57e9c96 --- headers/os/midi2/MidiProducer.h | 16 +++---- headers/os/midi2/MidiRoster.h | 20 ++++---- .../haiku_book/midi/midi2consumer.xml | 2 +- .../haiku_book/midi/midi2endpoint.xml | 30 ++++++------ .../haiku_book/midi/midi2localconsumer.xml | 39 ++++++++------- .../haiku_book/midi/midi2localproducer.xml | 47 +++++++++---------- .../haiku_book/midi/midi2producer.xml | 8 ++-- .../haiku_book/midi/midi2roster.xml | 46 +++++++++--------- 8 files changed, 103 insertions(+), 105 deletions(-) diff --git a/headers/os/midi2/MidiProducer.h b/headers/os/midi2/MidiProducer.h index 4904f3013f..f138a56735 100644 --- a/headers/os/midi2/MidiProducer.h +++ b/headers/os/midi2/MidiProducer.h @@ -23,7 +23,7 @@ private: friend class BMidiRoster; friend class BPrivate::BMidiRosterLooper; - BMidiProducer(const char* name = NULL); + BMidiProducer(const char *name = NULL); virtual ~BMidiProducer(); virtual void _Reserved1(); @@ -35,12 +35,12 @@ private: virtual void _Reserved7(); virtual void _Reserved8(); - status_t SendConnectRequest(BMidiConsumer*, bool); - void ConnectionMade(BMidiConsumer*); - bool ConnectionBroken(BMidiConsumer*); + status_t SendConnectRequest(BMidiConsumer *, bool); + void ConnectionMade(BMidiConsumer *); + bool ConnectionBroken(BMidiConsumer *); int32 CountConsumers() const; - BMidiConsumer* ConsumerAt(int32) const; + BMidiConsumer *ConsumerAt(int32) const; bool LockProducer() const; void UnlockProducer() const; @@ -61,7 +61,7 @@ public: virtual void Disconnected(BMidiConsumer *cons); void SprayData( - void* data, size_t length, bool atomic = false, + void *data, size_t length, bool atomic = false, bigtime_t time = 0) const; void SprayNoteOff( @@ -90,7 +90,7 @@ public: uchar channel, uchar lsb, uchar msb, bigtime_t time = 0) const; void SpraySystemExclusive( - void* data, size_t length, bigtime_t time = 0) const; + void *data, size_t length, bigtime_t time = 0) const; void SpraySystemCommon( uchar status, uchar data1, uchar data2, bigtime_t time = 0) const; @@ -108,7 +108,7 @@ protected: private: 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; virtual void _Reserved1(); diff --git a/headers/os/midi2/MidiRoster.h b/headers/os/midi2/MidiRoster.h index d902dd07de..92efbb187d 100644 --- a/headers/os/midi2/MidiRoster.h +++ b/headers/os/midi2/MidiRoster.h @@ -32,21 +32,21 @@ class BMidiRoster { public: - static BMidiEndpoint* NextEndpoint(int32* id); - static BMidiProducer* NextProducer(int32* id); - static BMidiConsumer* NextConsumer(int32* id); + static BMidiEndpoint *NextEndpoint(int32 *id); + static BMidiProducer *NextProducer(int32 *id); + static BMidiConsumer *NextConsumer(int32 *id); - static BMidiEndpoint* FindEndpoint(int32 id, bool localOnly = false); - static BMidiProducer* FindProducer(int32 id, bool localOnly = false); - static BMidiConsumer* FindConsumer(int32 id, bool localOnly = false); + static BMidiEndpoint *FindEndpoint(int32 id, bool localOnly = false); + static BMidiProducer *FindProducer(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 status_t Register(BMidiEndpoint* endp); - static status_t Unregister(BMidiEndpoint* endp); + static status_t Register(BMidiEndpoint *endp); + static status_t Unregister(BMidiEndpoint *endp); - static BMidiRoster* MidiRoster(); + static BMidiRoster *MidiRoster(); private: diff --git a/src/documentation/haiku_book/midi/midi2consumer.xml b/src/documentation/haiku_book/midi/midi2consumer.xml index bceea347d4..e2848f47ba 100644 --- a/src/documentation/haiku_book/midi/midi2consumer.xml +++ b/src/documentation/haiku_book/midi/midi2consumer.xml @@ -16,7 +16,7 @@ - bigtime_t BMidiConsumer::Latency() const + bigtime_t Latency() const The latency is measured in microseconds. Producers should attempt to get MIDI diff --git a/src/documentation/haiku_book/midi/midi2endpoint.xml b/src/documentation/haiku_book/midi/midi2endpoint.xml index 656d7d45ac..230160a21e 100644 --- a/src/documentation/haiku_book/midi/midi2endpoint.xml +++ b/src/documentation/haiku_book/midi/midi2endpoint.xml @@ -26,7 +26,7 @@ - const char* BMidiEndpoint::Name() const + const char* Name() const Returns the name of the endpoint. @@ -44,7 +44,7 @@ - void BMidiEndpoint::SetName(const char* name) + void SetName(const char* name) Changes the name of the endpoint. @@ -73,7 +73,7 @@ - int32 BMidiEndpoint::ID() const + int32 ID() const Returns the ID of the endpoint @@ -89,7 +89,7 @@ - bool BMidiEndpoint::IsProducer() const + bool IsProducer() const Determines whether this endpoint is a BMidiProducer @@ -109,7 +109,7 @@ - bool BMidiEndpoint::IsConsumer() const + bool IsConsumer() const Determines whether this endpoint is a BMidiConsumer @@ -128,7 +128,7 @@ - bool BMidiEndpoint::IsRemote() const + bool IsRemote() const Determines whether this endpoint is a proxy for a remote object. @@ -142,7 +142,7 @@ - bool BMidiEndpoint::IsLocal() const + bool IsLocal() const Determines whether this endpoint represents a local object @@ -155,7 +155,7 @@ - bool BMidiEndpoint::IsPersistent() const + bool IsPersistent() const Not used @@ -172,7 +172,7 @@ - bool BMidiEndpoint::IsValid() const + bool IsValid() const Determines whether the endpoint still exists @@ -203,7 +203,7 @@ - status_t BMidiEndpoint::Acquire() + status_t Acquire() Increments the endpoint's reference count @@ -252,7 +252,7 @@ - status_t BMidiEndpoint::Release() + status_t Release() Decrements the endpoint's reference count @@ -268,7 +268,7 @@ - status_t BMidiEndpoint::Register() + status_t Register() Publishes the endpoint on the roster @@ -317,7 +317,7 @@ - status_t BMidiEndpoint::Unregister() + status_t Unregister() Hides the endpoint from the roster @@ -329,7 +329,7 @@ - status_t BMidiEndpoint::SetProperties(const BMessage* properties) + status_t SetProperties(const BMessage* properties) Changes the properties of the endpoint @@ -423,7 +423,7 @@ - status_t BMidiEndpoint::GetProperties(BMessage* properties) const + status_t GetProperties(BMessage* properties) const Reads the properties of the endpoint diff --git a/src/documentation/haiku_book/midi/midi2localconsumer.xml b/src/documentation/haiku_book/midi/midi2localconsumer.xml index e95e8cbdb3..2fb618895d 100644 --- a/src/documentation/haiku_book/midi/midi2localconsumer.xml +++ b/src/documentation/haiku_book/midi/midi2localconsumer.xml @@ -46,7 +46,7 @@ - BMidiLocalConsumer::BMidiLocalConsumer(const char *name = NULL) + BMidiLocalConsumer(const char *name = NULL) Creates a new local consumer endpoint. @@ -82,7 +82,7 @@ - void BMidiLocalConsumer::SetLatency(bigtime_t latency) + void SetLatency(bigtime_t latency) Changes the published latency of the consumer. @@ -91,7 +91,7 @@ - int32 BMidiLocalConsumer::GetProducerID() + int32 GetProducerID() Returns the ID of the producer that most recently sent a MIDI event to @@ -105,7 +105,7 @@ - void BMidiLocalConsumer::SetTimeout(bigtime_t when, void *data) + void SetTimeout(bigtime_t when, void *data) Requests that the Timeout() hook will be called at some point @@ -146,7 +146,7 @@ - virtual void BMidiLocalConsumer::Timeout(void *data) + virtual void Timeout(void *data) Hook function that is called per your own request. @@ -158,7 +158,7 @@ - virtual void BMidiLocalConsumer::Data( + <title>virtual void Data( uchar *data, size_t length, bool atomic, bigtime_t time) @@ -205,7 +205,7 @@ - virtual void BMidiLocalConsumer::NoteOff( + <title>virtual void NoteOff( uchar channel, uchar note, uchar velocity, bigtime_t time) @@ -218,7 +218,7 @@ - virtual void BMidiLocalConsumer::NoteOn( + <title>virtual void NoteOn( uchar channel, uchar note, uchar velocity, bigtime_t time) @@ -231,7 +231,7 @@ - virtual void BMidiLocalConsumer::KeyPressure( + <title>virtual void KeyPressure( uchar channel, uchar note, uchar pressure, bigtime_t time) @@ -244,7 +244,7 @@ - virtual void BMidiLocalConsumer::ControlChange( + <title>virtual void ControlChange( uchar channel, uchar controlNumber, uchar controlValue, bigtime_t time) @@ -257,7 +257,7 @@ - virtual void BMidiLocalConsumer::ProgramChange( + <title>virtual void ProgramChange( uchar channel, uchar programNumber, bigtime_t time) @@ -270,7 +270,7 @@ - virtual void BMidiLocalConsumer::ChannelPressure( + <title>virtual void ChannelPressure( uchar channel, uchar pressure, bigtime_t time) @@ -283,7 +283,7 @@ - virtual void BMidiLocalConsumer::PitchBend( + <title>virtual void PitchBend( uchar channel, uchar lsb, uchar msb, bigtime_t time) @@ -296,9 +296,8 @@ - virtual void BMidiLocalConsumer::SystemExclusive( - void* data, size_t length, bigtime_t time) - + virtual void SystemExclusive( + void* data, size_t length, bigtime_t time) Invoked when a System Exclusive event is received @@ -320,7 +319,7 @@ - virtual void BMidiLocalConsumer::SystemCommon( + <title>virtual void SystemCommon( uchar status, uchar data1, uchar data2, bigtime_t time) @@ -337,7 +336,7 @@ - virtual void BMidiLocalConsumer::SystemRealTime( + <title>virtual void SystemRealTime( uchar status, bigtime_t time) @@ -350,7 +349,7 @@ - virtual void BMidiLocalConsumer::TempoChange(int32 beatsPerMinute, bigtime_t time) + virtual void TempoChange(int32 beatsPerMinute, bigtime_t time) Invoked when a Tempo Change event is received @@ -362,7 +361,7 @@ - virtual void BMidiLocalConsumer::AllNotesOff(bool justChannel, bigtime_t time) + virtual void AllNotesOff(bool justChannel, bigtime_t time) Not used diff --git a/src/documentation/haiku_book/midi/midi2localproducer.xml b/src/documentation/haiku_book/midi/midi2localproducer.xml index 39ff2d863f..4cad7b7842 100644 --- a/src/documentation/haiku_book/midi/midi2localproducer.xml +++ b/src/documentation/haiku_book/midi/midi2localproducer.xml @@ -34,7 +34,7 @@ - BMidiLocalProducer::BMidiLocalProducer(const char *name = NULL) + BMidiLocalProducer(const char *name = NULL) Creates a new local producer endpoint. @@ -70,7 +70,7 @@ - virtual void BMidiLocalProducer::Connected(BMidiConsumer *cons) + virtual void Connected(BMidiConsumer *cons) Invoked when a new consumer is connected to this producer @@ -100,7 +100,7 @@ - virtual void BMidiLocalProducer::Disconnected(BMidiConsumer *cons) + virtual void Disconnected(BMidiConsumer *cons) Invoked when a consumer is disconnected from this producer. @@ -112,8 +112,8 @@ - void BMidiLocalProducer::SprayData( - void *data, size_t length, bool atomic = false, bigtime_t time = 0) const + void SprayData( + void *data, size_t length, bool atomic = false, bigtime_t time = 0) const Sends raw MIDI data downstream to all connected consumers @@ -149,7 +149,7 @@ - void BMidiLocalProducer::SprayNoteOff( + <title>void SprayNoteOff( uchar channel, uchar note, uchar velocity, bigtime_t time = 0) const @@ -162,7 +162,7 @@ - void BMidiLocalProducer::SprayNoteOn( + <title>void SprayNoteOn( uchar channel, uchar note, uchar velocity, bigtime_t time = 0) const @@ -175,7 +175,7 @@ - void BMidiLocalProducer::SprayKeyPressure( + <title>void SprayKeyPressure( uchar channel, uchar note, uchar pressure, bigtime_t time = 0) const @@ -189,9 +189,9 @@ - void BMidiLocalProducer::SprayControlChange( + <title>void SprayControlChange( uchar channel, uchar controlNumber, uchar controlValue, - bigtime_t time = 0) const + bigtime_t time = 0) const Sends a Controller Change event to all connected consumers. @@ -204,9 +204,9 @@ - BMidiLocalProducer::SprayProgramChange( - uchar channel, uchar programNumber, bigtime_t time = 0) const - + void SprayProgramChange( + uchar channel, uchar programNumber, bigtime_t time = 0) const + Sends a Program Change event to all connected consumers @@ -217,8 +217,8 @@ - void BMidiLocalProducer::SprayChannelPressure( - uchar channel, uchar pressure, bigtime_t time = 0) const + void SprayChannelPressure( + uchar channel, uchar pressure, bigtime_t time = 0) const Sends a Channel Pressure event to all connected consumers @@ -230,8 +230,8 @@ - void BMidiLocalProducer::SprayPitchBend( - uchar channel, uchar lsb, uchar msb, bigtime_t time = 0) const + void SprayPitchBend( + uchar channel, uchar lsb, uchar msb, bigtime_t time = 0) const Sends a Pitch Bend event to all connected consumers @@ -243,9 +243,8 @@ - - void BMidiLocalProducer::SpraySystemExclusive( - void *data, size_t length, bigtime_t time = 0) const + void SpraySystemExclusive( + void *data, size_t length, bigtime_t time = 0) const Sends a System Exclusive event to all connected consumers @@ -264,7 +263,7 @@ - void BMidiLocalProducer::SpraySystemCommon( + <title>void SpraySystemCommon( uchar status, uchar data1, uchar data2, bigtime_t time = 0) const @@ -322,7 +321,7 @@ - void BMidiLocalProducer::SpraySystemRealTime( + <title>void SpraySystemRealTime( uchar status, bigtime_t time = 0) const @@ -383,8 +382,8 @@ - void BMidiLocalProducer::SprayTempoChange( - int32 bpm, bigtime_t time = 0) const + void SprayTempoChange( + int32 beatsPerMinute, bigtime_t time = 0) const Sends a Tempo Change event to the connected consumers. diff --git a/src/documentation/haiku_book/midi/midi2producer.xml b/src/documentation/haiku_book/midi/midi2producer.xml index 8c967f7020..118401fb1f 100644 --- a/src/documentation/haiku_book/midi/midi2producer.xml +++ b/src/documentation/haiku_book/midi/midi2producer.xml @@ -20,7 +20,7 @@ - status_t BMidiProducer::Connect(BMidiConsumer *cons) + status_t Connect(BMidiConsumer *cons) Connects a consumer to this producer @@ -45,7 +45,7 @@ - status_t BMidiProducer::Disconnect(BMidiConsumer *cons) + status_t Disconnect(BMidiConsumer *cons) Disconnects a consumer from this producer @@ -67,7 +67,7 @@ - bool BMidiProducer::IsConnected(BMidiConsumer *cons) const + bool IsConnected(BMidiConsumer *cons) const Determines whether a consumer is connected to this producer @@ -80,7 +80,7 @@ - BList *BMidiProducer::Connections() const + BList *Connections() const Returns a list with all connected consumers diff --git a/src/documentation/haiku_book/midi/midi2roster.xml b/src/documentation/haiku_book/midi/midi2roster.xml index d2ea39b740..7048feb723 100644 --- a/src/documentation/haiku_book/midi/midi2roster.xml +++ b/src/documentation/haiku_book/midi/midi2roster.xml @@ -26,12 +26,12 @@ You can call BMidiRoster's functions like this: - producer = BMidiRoster::FindProducer(someID); + producer = FindProducer(someID); Or using the slightly more annoying: - BMidiRoster* roster = BMidiRoster::MidiRoster(); + BMidiRoster *roster = MidiRoster(); if (roster != NULL) { producer = roster->FindProducer(someID); @@ -40,7 +40,7 @@ - BMidiEndpoint* BMidiRoster::NextEndpoint(int32* id) + static BMidiEndpoint *NextEndpoint(int32 *id) Returns the next endpoint from the roster @@ -61,8 +61,8 @@ Usage example: int32 id = 0; - BMidiEndpoint* endp; - while ((endp = BMidiRoster::NextEndpoint(&id)) != NULL) + BMidiEndpoint *endp; + while ((endp = NextEndpoint(&id)) != NULL) { ...do something with endpoint ... endp->Release(); // don't forget! @@ -78,7 +78,7 @@ - BMidiProducer* BMidiRoster::NextProducer(int32* id) + static BMidiProducer *NextProducer(int32 *id) Returns the next producer from the roster @@ -95,7 +95,7 @@ - BMidiConsumer* BMidiRoster::NextConsumer(int32* id) + static BMidiConsumer *NextConsumer(int32 *id) Returns the next consumer from the roster @@ -112,7 +112,7 @@ - BMidiEndpoint* BMidiRoster::FindEndpoint( + <title>static BMidiEndpoint *FindEndpoint( int32 id, bool localOnly = false) @@ -133,17 +133,17 @@ - BMidiEndpoint* endp = ...; - BMidiProducer* prod = NULL; - BMidiConsumer* cons = NULL; + BMidiEndpoint *endp = ...; + BMidiProducer *prod = NULL; + BMidiConsumer *cons = NULL; if (endp->IsProducer()) { - prod = dynamic_cast<BMidiProducer*>(endp); + prod = dynamic_cast<BMidiProducer *>(endp); } else if (endp->IsConsumer()) { - cons = dynamic_cast<BMidiConsumer*>(endp); + cons = dynamic_cast<BMidiConsumer *>(endp); } @@ -152,7 +152,7 @@ should always \link BMidiEndpoint::Release() Release() \endlink an endpoint when you are done with it: - BMidiEndpoint* endp = BMidiRoster::FindEndpoint(someID); + BMidiEndpoint *endp = FindEndpoint(someID); if (endp != NULL) { ...do stuff with the endpoint... @@ -163,7 +163,7 @@ - BMidiProducer* BMidiRoster::FindProducer( + <title>static BMidiProducer *FindProducer( int32 id, bool localOnly = false) @@ -182,7 +182,7 @@ - BMidiConsumer* BMidiRoster::FindConsumer( + <title>static BMidiConsumer *FindConsumer( int32 id, bool localOnly = false) @@ -201,7 +201,7 @@ - void BMidiRoster::StartWatching(const BMessenger* msngr) + static void StartWatching(const BMessenger *msngr) Start receiving notifications from the Midi Roster @@ -464,10 +464,10 @@ void MyView::AttachedToWindow() { BMessenger msgr(this); - BMidiRoster::StartWatching(&msgr); + StartWatching(&msgr); } - void MyView::MessageReceived(BMessage* msg) + void MyView::MessageReceived(BMessage *msg) { switch (msg->what) { @@ -488,7 +488,7 @@ - void BMidiRoster::StopWatching() + static void StopWatching() Stop receiving notifications from the Midi Roster @@ -500,7 +500,7 @@ - status_t BMidiRoster::Register(BMidiEndpoint* object) + static status_t Register(BMidiEndpoint *endp) Publishes an endpoint to other applications @@ -513,7 +513,7 @@ - status_t BMidiRoster::Unregister(BMidiEndpoint* object) + static status_t Unregister(BMidiEndpoint *endp) Hides an endpoint from other applications @@ -526,7 +526,7 @@ - BMidiRoster* BMidiRoster::MidiRoster() + static BMidiRoster *MidiRoster() Returns a pointer to the only instance of BMidiRoster