From 436505bb715f1c5dde687d117722f9cb98432c63 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=B4me=20Duval?= Date: Sun, 15 Oct 2006 19:45:46 +0000 Subject: [PATCH] added links git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@19070 a95241bf-73f2-0310-859d-f6bbb57e9c96 --- .../haiku_book/midi/midi2api.xml | 3 +++ .../haiku_book/midi/midi2localconsumer.xml | 18 +++++++-------- .../haiku_book/midi/midi2localproducer.xml | 4 ++-- .../haiku_book/midi/midi2roster.xml | 22 +++++++++---------- 4 files changed, 25 insertions(+), 22 deletions(-) diff --git a/src/documentation/haiku_book/midi/midi2api.xml b/src/documentation/haiku_book/midi/midi2api.xml index ac5e41189e..af748cd6fe 100644 --- a/src/documentation/haiku_book/midi/midi2api.xml +++ b/src/documentation/haiku_book/midi/midi2api.xml @@ -11,6 +11,8 @@ BMidiRoster"> +FindEndpoint()"> +NextEndpoint()"> Register()"> Unregister()"> StartWatching()"> @@ -34,6 +36,7 @@ BMidiLocalConsumer"> BMidiLocalConsumer"> +Timeout"> BMidiLocalProducer"> diff --git a/src/documentation/haiku_book/midi/midi2localconsumer.xml b/src/documentation/haiku_book/midi/midi2localconsumer.xml index 5ffd8f5b88..8492e056fd 100644 --- a/src/documentation/haiku_book/midi/midi2localconsumer.xml +++ b/src/documentation/haiku_book/midi/midi2localconsumer.xml @@ -58,7 +58,7 @@ - The new endpoint is not visible to other applications until you Register() it. + The new endpoint is not visible to other applications until you &BMidiRoster_Register; it. @@ -71,7 +71,7 @@ There is no guarantee that the endpoint will be successfully created. For example, the Midi Server may not be running. Therefore, you should always call IsValid() after creating a new endpoint to make sure that everything went okay. - If not, Release() the object to reclaim memory and abort gracefully. + If not, &BMidiEndpoint_Release; the object to reclaim memory and abort gracefully. @@ -116,13 +116,13 @@ SetTimeoutbigtime_twhenvoid *data - Requests that the Timeout() hook will be called at some point + Requests that the &BMidiLocalConsumer_Timeout; hook will be called at some point - This method asks the consumer thread to call the Timeout() hook as soon as + This method asks the consumer thread to call the &BMidiLocalConsumer_Timeout; hook as soon as possible after the timeout expires. For every call to SetTimeout(), the - Timeout() hook is only called once. Note: the term "timeout" may be a little + &BMidiLocalConsumer_Timeout; hook is only called once. Note: the term "timeout" may be a little misleading; the hook will always be called, even if events are received in the mean time. Apparently, this facility is handy for dealing with early events. @@ -135,7 +135,7 @@ forever. Your call to SetTimeout() doesn't change this. The new timeout value will go into effect the next time the thread tries to read from the port, i.e. after the first event has been received. If no event ever comes in, the - Timeout() hook will never be called. This also means that you cannot cancel a + &BMidiLocalConsumer_Timeout; hook will never be called. This also means that you cannot cancel a timeout once you have set it. To repeat, calling SetTimeout() only takes effect after at least one new event has been received. @@ -146,9 +146,9 @@ when An absolute time that's measured against the system clock. data A pointer to a "cookie" that - you can pass along to Timeout(). The data is not copied, so - you must ensure that the pointer remains valid until Timeout() is - called. You typically delete the data inside Timeout(). + you can pass along to &BMidiLocalConsumer_Timeout;. The data is not copied, so + you must ensure that the pointer remains valid until &BMidiLocalConsumer_Timeout; is + called. You typically delete the data inside &BMidiLocalConsumer_Timeout;. diff --git a/src/documentation/haiku_book/midi/midi2localproducer.xml b/src/documentation/haiku_book/midi/midi2localproducer.xml index 8276a9df6e..b88bf15f25 100644 --- a/src/documentation/haiku_book/midi/midi2localproducer.xml +++ b/src/documentation/haiku_book/midi/midi2localproducer.xml @@ -56,8 +56,8 @@ There is no guarantee that the endpoint will be successfully created. For example, the Midi Server may not be running. Therefore, you should always call - IsValid() after creating a new endpoint to make sure that everything went okay. - If not, Release() the object to reclaim memory and abort gracefully. + &BMidiEndpoint_IsValid; after creating a new endpoint to make sure that everything went okay. + If not, &BMidiEndpoint_Release; the object to reclaim memory and abort gracefully. diff --git a/src/documentation/haiku_book/midi/midi2roster.xml b/src/documentation/haiku_book/midi/midi2roster.xml index 1ae16d39c1..0c252321d5 100644 --- a/src/documentation/haiku_book/midi/midi2roster.xml +++ b/src/documentation/haiku_book/midi/midi2roster.xml @@ -55,7 +55,7 @@ returns, it sets id to the ID of the endpoint that was found. If no more endpoints exist, NextEndpoint() returns NULL and id is not changed. NextEndpoint() does not return locally created endpoints, even if they - are Register()'ed. + are &BMidiEndpoint_Register;'ed. @@ -87,7 +87,7 @@ - Like NextEndpoint(), but only returns producer endpoints. + Like &BMidiRoster_NextEndpoint;, but only returns producer endpoints. @@ -105,7 +105,7 @@ - Like NextEndpoint(), but only returns consumer endpoints. + Like &BMidiRoster_NextEndpoint;, but only returns consumer endpoints. @@ -124,7 +124,7 @@ FindEndpoint() will always find any local endpoints created by this - application; they do not have to be published with Register() first. If + application; they do not have to be published with &BMidiRoster_Register; first. If localOnly is false, FindEndpoint() also looks at remote endpoints, otherwise only local endpoints will be resolved. Returns NULL if no such endpoint could be found. @@ -152,7 +152,7 @@ Remember that FindEndpoint() increments the endpoint's reference count, so you - should always \link BMidiEndpoint::Release() Release() \endlink an endpoint + should always &BMidiEndpoint_Release; an endpoint when you are done with it: BMidiEndpoint *endp = FindEndpoint(someID); @@ -174,7 +174,7 @@ - Like FindEndpoint(), but only looks for producer endpoints. Returns NULL if no + Like &BMidiRoster_FindEndpoint;, but only looks for producer endpoints. Returns NULL if no endpoint with that ID exists, or if that endpoint is not a producer. @@ -193,7 +193,7 @@ - Like FindEndpoint(), but only looks for consumer endpoints. Returns NULL if no + Like &BMidiRoster_FindEndpoint;, but only looks for consumer endpoints. Returns NULL if no endpoint with that ID exists, or if that endpoint is not a consumer. @@ -296,8 +296,8 @@ The "connected" and "disconnected" notifications are sent when a consumer - BMidiProducer::Connect()'s to a producer, or when they table - BMidiProducer::Disconnect(). You will receive these + &BMidiProducer_Connect;'s to a producer, or when they + &BMidiProducer_Disconnect;. You will receive these notifications when any two endpoints connect or disconnect, even if they are not published. (The purpose of which is debatable.) You won't receive the notifications if you are the one making the connection, even if both endpoints @@ -494,7 +494,7 @@ - See Also"The possible be:op codes (BMidiOp)". + See Also "The possible be:op codes (BMidiOp)". @@ -548,7 +548,7 @@ - There is no real reason use this function, since all BMidiRoster's public + There is no real reason to use this function, since all BMidiRoster's public function are static.