ExternalVendorCode/genode
1
0
Fork 0
mirror of https://github.com/genodelabs/genode.git synced 2025-06-23 17:17:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Revised API documentation

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files

4
repos/os/include/packet_stream_tx/packet_stream_tx.h
View File

@ -29,10 +29,10 @@ struct Packet_stream_tx::Channel
/**
* Request transmission interface
*
* This function enables the client-side use of the 'Channel' using
* This method enables the client-side use of the 'Channel' using
* the abstract 'Channel' interface only. This is useful in cases
* where both source and sink of the 'Channel' are co-located in
* one program. At the server side of the 'Channel', this function
* one program. At the server side of the 'Channel', this method
* has no meaning.
*/
virtual Source *source() { return 0; }

4
repos/os/include/packet_stream_tx/rpc_object.h
View File

@ -58,7 +58,7 @@ class Packet_stream_tx::Rpc_object : public Genode::Rpc_object<CHANNEL, Rpc_obje
~Rpc_object() { _ep.dissolve(this); }
/*
* The 'sigh_packet_avail()' and 'sigh_ready_to_ack()' functions
* The 'sigh_packet_avail()' and 'sigh_ready_to_ack()' methods
* may be called at session-creation time to override the default
* data-flow signal handlers as provided by the packet-stream sink.
* The default handlers let the server block in the event of data
@ -66,7 +66,7 @@ class Packet_stream_tx::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.
*/