i2p/haiku-beta6
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

added links

Browse Source 
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@19070 a95241bf-73f2-0310-859d-f6bbb57e9c96
This commit is contained in:
Jérôme Duval
2006-10-15 19:45:46 +00:00
parent 81435928fb
commit 436505bb71
4 changed files with 25 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/documentation/haiku_book/midi/midi2api.xml
+3
View File
@@ -11,6 +11,8 @@
<!ENTITY midi2roster SYSTEM "midi2roster.xml">
<!ENTITY BMidiRoster "<link linkend='bmidiroster'><classname>BMidiRoster</classname></link>">
<!ENTITY BMidiRoster_FindEndpoint "<link linkend='bmidiroster_findendpoint'><function>FindEndpoint()</function></link>">
<!ENTITY BMidiRoster_NextEndpoint "<link linkend='bmidiroster_nextendpoint'><function>NextEndpoint()</function></link>">
<!ENTITY BMidiRoster_Register "<link linkend='bmidiroster_register'><function>Register()</function></link>">
<!ENTITY BMidiRoster_Unregister "<link linkend='bmidiroster_unregister'><function>Unregister()</function></link>">
<!ENTITY BMidiRoster_StartWatching "<link linkend='bmidiroster_startwatching'><function>StartWatching()</function></link>">
@@ -34,6 +36,7 @@
<!ENTITY BMidiLocalConsumer "<link linkend='midi2localconsumer'><classname>BMidiLocalConsumer</classname></link>">
<!ENTITY BMidiLocalConsumer_ChannelPressure "<link linkend='bmidilocalconsumer_channelpressure'><function>BMidiLocalConsumer</function></link>">
<!ENTITY BMidiLocalConsumer_Timeout "<link linkend='bmidilocalconsumer_timeout'><function>Timeout</function></link>">
<!ENTITY BMidiLocalProducer "<link linkend='bmidilocalproducer'><classname>BMidiLocalProducer</classname></link>">
src/documentation/haiku_book/midi/midi2localconsumer.xml
+9 -9
View File
@@ -58,7 +58,7 @@
</para>
<para>
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.
</para>
<para>
@@ -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.
</para>
<para>
@@ -116,13 +116,13 @@
<methodsynopsis><void/><methodname>SetTimeout</methodname><methodparam><type>bigtime_t</type><parameter>when</parameter></methodparam><methodparam><type>void *</type><parameter>data</parameter></methodparam></methodsynopsis>
<para>
Requests that the Timeout() hook will be called at some point
Requests that the &BMidiLocalConsumer_Timeout; hook will be called at some point
</para>
<para>
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 <emphasis>always</emphasis> 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.
</para>
@@ -146,9 +146,9 @@
<listitem><para><parameter>when</parameter> An absolute time that's
measured against the system clock.</para></listitem>
<listitem><para><parameter>data</parameter> 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().</para></listitem>
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;.</para></listitem>
</itemizedlist>
</para>
</sect3>
src/documentation/haiku_book/midi/midi2localproducer.xml
+2 -2
View File
@@ -56,8 +56,8 @@
<para>
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.
</para>
<para>
src/documentation/haiku_book/midi/midi2roster.xml
+11 -11
View File
@@ -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 <emphasis>not</emphasis> return locally created endpoints, even if they
are Register()'ed.
are &BMidiEndpoint_Register;'ed.
</para>
<para>
@@ -87,7 +87,7 @@
</para>
<para>
Like NextEndpoint(), but only returns producer endpoints.
Like &BMidiRoster_NextEndpoint;, but only returns producer endpoints.
</para>
<para>
@@ -105,7 +105,7 @@
</para>
<para>
Like NextEndpoint(), but only returns consumer endpoints.
Like &BMidiRoster_NextEndpoint;, but only returns consumer endpoints.
</para>
<para>
@@ -124,7 +124,7 @@
<para>
FindEndpoint() will always find <emphasis>any</emphasis> 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 @@
<para>
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:
<programlisting>
BMidiEndpoint *endp = FindEndpoint(someID);
@@ -174,7 +174,7 @@
</para>
<para>
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.
</para>
@@ -193,7 +193,7 @@
</para>
<para>
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.
</para>
@@ -296,8 +296,8 @@
<para>
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 <emphasis>any</emphasis> 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 @@
</para>
<para>
See Also<link linkend="bmidiop">"The possible be:op codes (BMidiOp)"</link>.
See Also <link linkend="bmidiop">"The possible be:op codes (BMidiOp)"</link>.
</para>
</sect3>
@@ -548,7 +548,7 @@
</para>
<para>
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.
</para>
</sect3>