reorganize and update documentation; fix compiler warning

git-svn-id: svn://svn.linux1394.org/libraw1394/trunk@144 53a565d1-3bb7-0310-b661-cf11e63c67ab

1 files changed, 0 insertions, 79 deletions

diff --git a/src/readwrite.c b/src/readwrite.c
index 4e2e6ea..8f5948d 100644
--- a/src/readwrite.c
+++ b/src/readwrite.c
@@ -31,25 +31,6 @@
 #include "raw1394_private.h"
 
 
-/**
- * raw1394_start_read - initiate a read transaction
- * @node: target node
- * @addr: address to read from
- * @length: amount of data to read
- * @buffer: pointer to buffer where data will be saved
- * @tag: data to identify the request to completion handler
- *
- * This function starts the specified read request and returns %0 for success
- * and a negative number for an error, in which case errno will be set.  If
- * @length is %4 a quadlet read is initiated and a block read otherwise.
- *
- * The transaction is only started, no success of the transaction is implied
- * with a successful return of this function.  When the transaction completes, a
- * raw1394_loop_iterate() will call the tag handler and pass it the tag and
- * error code of the transaction.  @tag should therefore be set to something
- * that uniquely identifies this transaction (e.g. a struct pointer casted to
- * unsigned long).
- **/
 int raw1394_start_read(struct raw1394_handle *handle, nodeid_t node,
                        nodeaddr_t addr, size_t length, quadlet_t *buffer,
                        unsigned long tag)
@@ -70,25 +51,6 @@ int raw1394_start_read(struct raw1394_handle *handle, nodeid_t node,
 }
 
 
-/**
- * raw1394_start_write - initiate a write transaction
- * @node: target node
- * @addr: address to write to
- * @length: amount of data to write
- * @data: pointer to data to be sent
- * @tag: data to identify the request to completion handler
- *
- * This function starts the specified write request and returns %0 for success
- * and a negative number for an error, in which case errno will be set.  If
- * @length is %4 a quadlet write is initiated and a block write otherwise.
- *
- * The transaction is only started, no success of the transaction is implied
- * with a successful return of this function.  When the transaction completes, a
- * raw1394_loop_iterate() will call the tag handler and pass it the tag and
- * error code of the transaction.  @tag should therefore be set to something
- * that uniquely identifies this transaction (e.g. a struct pointer casted to
- * unsigned long).
- **/
 int raw1394_start_write(struct raw1394_handle *handle, nodeid_t node,
                         nodeaddr_t addr, size_t length, quadlet_t *data,
                         unsigned long tag)
@@ -109,26 +71,6 @@ int raw1394_start_write(struct raw1394_handle *handle, nodeid_t node,
 }
 
 
-/**
- * raw1394_start_lock - initiate a lock transaction
- * @node: target node
- * @addr: address to read from
- * @extcode: extended transaction code determining the lock operation
- * @data: data part of lock parameters
- * @arg: arg part of lock parameters
- * @result: address where return value will be written
- * @tag: data to identify the request to completion handler
- *
- * This function starts the specified lock request and returns %0 for success
- * and a negative number for an error, in which case errno will be set.
- *
- * The transaction is only started, no success of the transaction is implied
- * with a successful return of this function.  When the transaction completes, a
- * raw1394_loop_iterate() will call the tag handler and pass it the tag and
- * error code of the transaction.  @tag should therefore be set to something
- * that uniquely identifies this transaction (e.g. a struct pointer casted to
- * unsigned long).
- **/
 int raw1394_start_lock(struct raw1394_handle *handle, nodeid_t node,
                        nodeaddr_t addr, unsigned int extcode, quadlet_t data,
                        quadlet_t arg, quadlet_t *result, unsigned long tag)
@@ -207,27 +149,6 @@ int raw1394_start_lock64(struct raw1394_handle *handle, nodeid_t node,
 }
 
 
-/**
- * raw1394_start_iso_write - initiate an isochronous packet write
- * @channel: channel number on which to send on
- * @tag: data to be put into packet's tag field
- * @sy: data to be put into packet's sy field
- * @speed: speed at which to send
- * @length: amount of data to send
- * @data: pointer to data to send
- * @rawtag: data to identify the request to completion handler
- *
- * This function starts the specified isochronous packet transmission and
- * returns %0 for success and a negative number for an error, in which case
- * errno will be set.
- *
- * When the send completes, a raw1394_loop_iterate() will call the tag handler
- * and pass it the tag and error code of the transaction.  @tag should therefore
- * be set to something that uniquely identifies this transaction (e.g. a struct
- * pointer casted to unsigned long).
- *
- * Isochronous packets are automatically
- **/
 int raw1394_start_iso_write(struct raw1394_handle *handle, unsigned int channel,
                             unsigned int tag, unsigned int sy,
                             unsigned int speed, size_t length, quadlet_t *data,