Thread (46 messages) 46 messages, 4 authors, 2010-02-02

RE: [PATCH net-next-2.6 10/13] net-caif: add kernel-client API for CAIF

From: Sjur Brændeland <hidden>
Date: 2010-01-26 20:11:14

Hi Randy,

Randy Dunlap wrote:
On Wed, 20 Jan 2010 23:55:27 +0100 sjur.brandeland@stericsson.com

Hi,

I'm probably repeating myself here, but this function documentation
is not formatted in the way which the Linux kernel expects/wants. 

Some of the others (after this one) use "/**" to begin the comment
block. 
In kernel-land, that is used only for kernel-doc formatted notation.
Thanks for feedback, it is rather my fault letting this slip through.
As you probably have figured CAIF was originally documented using
doxygen for formatting. Unfortunately I have not yet managed to get rid of this.
quoted
+/*!\page  caif_kernel.h
+ * This is the specification of the CAIF kernel internal interface
to + * CAIF Channels. + * This interface follows the pattern used in
Linux device drivers +with a + *  struct \ref caif_device
+ * holding control data handling each device instance. + *
+ * The functional interface consists of a few basic functions:
+ *  - \ref caif_add_device             Configure and connect the
CAIF + *               channel to the remote end. Configuration is
described in + *               \ref caif_channel_config.
+ *  - \ref caif_remove_device          Disconnect and remove the
channel. + *  - \ref caif_transmit               Sends a CAIF
message on the link. + *  - \ref caif_device.receive_cb      Receive
callback function for + *                receiving packets.
+ *  - \ref caif_device.control_cb      Control information from the
CAIF stack. + *  - \ref caif_flow_control           Send flow
control message to remote end. + * + *
+ * Details:
+ * \see { caif_kernel }
+ *
+ * \code
+ *
+#include <net/caif/caif_kernel.h>"
BR/Sjur
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help