Revised API documentation

This patch curates the API documentation to become suitable for the
functional specificaton, which is partially generated from the header
files.
This commit is contained in:
Norman Feske
2015-03-20 17:50:41 +01:00
committed by Christian Helmuth
parent 7441df33c9
commit eaac3cc1bd
107 changed files with 610 additions and 444 deletions

View File

@ -59,7 +59,7 @@ class Packet_stream_rx::Rpc_object : public Genode::Rpc_object<CHANNEL, Rpc_obje
~Rpc_object() { _ep.dissolve(this); }
/*
* The 'sigh_ack_avail()' and 'sigh_ready_to_submit()' functions
* The 'sigh_ack_avail()' and 'sigh_ready_to_submit()' methods
* may be called at session-creation time to override the default
* data-flow signal handlers as provided by the packet-stream source.
* The default handlers let the server block in the event of data
@ -67,7 +67,7 @@ class Packet_stream_rx::Rpc_object : public Genode::Rpc_object<CHANNEL, Rpc_obje
* implementation is able to avoid blocking for a single event by
* facilitating the use of a select-like mode of operation.
*
* Note that calling these functions after the finished creation of
* Note that calling these methods after the finished creation of
* the session has no effect because the client queries the signal
* handlers only once at session-creation time.
*/