]> rtime.felk.cvut.cz Git - frescor/fwp.git/commitdiff
Now, the comments are better recognize by doxygen.
authorMichal Sojka <sojkam1@fel.cvut.cz>
Thu, 10 Jan 2008 09:37:51 +0000 (10:37 +0100)
committerMichal Sojka <sojkam1@fel.cvut.cz>
Thu, 10 Jan 2008 09:37:51 +0000 (10:37 +0100)
fwp/Doxyfile
fwp/libfwp/include/fwp_conf.h
fwp/libfwp/include/fwp_contract.h
fwp/libfwp/include/fwp_msg.h
fwp/libfwp/include/fwp_msgq.h
fwp/libfwp/src/fwp_ac.c
fwp/libfwp/src/fwp_fna.c
fwp/libfwp/src/fwp_vres.c

index d782285223f0d35c28da4dd97fb33ff045d5d26c..c69678b965dbc9a5b2d3682de82bf94ef4b086f7 100644 (file)
@@ -133,7 +133,7 @@ FILE_PATTERNS          = *.c \
                          *.PY \
                          *.F90
 RECURSIVE              = YES
-EXCLUDE                = 
+EXCLUDE                = _build _compiled
 EXCLUDE_SYMLINKS       = NO
 EXCLUDE_PATTERNS       = 
 EXCLUDE_SYMBOLS        = 
index 62369a76eb04550dc489f0fbb9501da00d4729a5..d9b6c40e34219d82a0cd0295716789abe4f6dc03 100644 (file)
@@ -1,7 +1,7 @@
 #ifndef _FWP_CONF_H
 #define _FWP_CONF_H
 
-/* Number of ACs */
+/** Number of ACs */
 #define FWP_AC_NUM 4
  
 #define FWP_MSGQ_SIZE 20 
index 8d4bcfdca0b72d75dadb082560f8a60acca8e8b3..ce61973f777b445e8aaf2618327b6d3d4d3cb72e 100644 (file)
@@ -9,10 +9,10 @@ enum contract_status_t {
 };
 
 struct fwp_contract {
-       unsigned int id;        /*/< global vres_id */ 
-       unsigned int ac_id;     /*/< AC id ~ priority of vres */ 
-       int budget;             /*/<  */
-       long period_usec;       /*/< all time units are in microseconds */
+       unsigned int id;        /**< global vres_id */ 
+       unsigned int ac_id;     /**< AC id ~ priority of vres */ 
+       int budget;             /**< bytes per period */
+       long period_usec;       /**< all time units are in microseconds */
        int status;
 };
 
index 07f028e0935c4ef0c5355c59b97db27f6027a211..6bc1eb4b0e82a206feb61953db8c374c0c6f5006 100644 (file)
@@ -9,14 +9,14 @@
 
 struct fwp_msg_header{
        uint8_t code;
-       uint16_t hid;           /* /< handshake ID */
+       uint16_t hid;           /**< handshake ID */
 }__attribute__((packed));
 
 struct fwp_msg_contract{
-       uint16_t id;            /*/< global contract_id */ 
-       uint8_t  ac_id;         /*/< AC id ~ priority of vres */ 
-       uint16_t budget;                /*/< bits per second */
-       uint32_t period_usec;   /*/< all time units are in microseconds */
+       uint16_t id;            /**< global contract_id */ 
+       uint8_t  ac_id;         /**< AC id ~ priority of vres */ 
+       uint16_t budget;        /**< bits per second */
+       uint32_t period_usec;   /**< all time units are in microseconds */
        uint8_t  status;
 }__attribute__((packed));
 
index 840dffb01deb5ada3f9a887138cae9cbbc21049d..d36cf1fafefd1c2068f4f52d73a6626accaf80ce 100644 (file)
@@ -6,7 +6,7 @@
 
 
 struct fwp_msgq {
-       unsigned int nr_pending;  /*/< number of messages in the queue */
+       unsigned int nr_pending;  /**< number of messages in the queue */
 
        /* queue reject policy */
        /*queue_rejection_policy qr_policy;*/
index c1532fbab213f0eadab09697f4ad13f0abd5fc45..546e40ccb6eff7e115e42a6dca13c6bebf84542c 100644 (file)
@@ -1,7 +1,7 @@
 #include "fwp_ac.h"
 #include "fwp_util.h"
 
-/* WMM defines 4 queues */
+/** WMM defines 4 queues */
 enum ac_id_t {
        FWP_AC_VO = 0,
        FWP_AC_VI = 1,
index c35ef239106cb3033342828e70f83db7c1180679..6a7f3e3da9b29dec9de1ed9354fb3bc685bebc5f 100644 (file)
@@ -8,7 +8,7 @@ int fwp_fna_init(const frsh_resource_id_t resource_id);
        fwp_init();
 }
 
-/* FNA negotiate routines */
+/** FNA negotiate routine */
 
 int fwp_fna_contract_negotiate
        (const frsh_resource_id_t resource_id,
@@ -31,7 +31,7 @@ int fwp_fna_contract_negotiate
 }
 
 
-/* FNA send routines */
+/** FNA send routine */
 
 int fwp_fna_send(const fna_endpoint_data_t *endpoint,const void *msg,
                   const size_t size, int flags)
@@ -59,7 +59,7 @@ int fwp_fna_send_async(const fna_endpoint_data_t *endpoint,const void *msg,
        return fwp_fna_send(endpoint, msg, size, MSG_DONTWAIT)
 {
 
-/* FNA receive routines */
+/** FNA receive routines */
 
 int fwp_fna_receive(const fna_endpoint_data_t *endpoint, void *buffer, 
                         const size_t buffer_size, size_t *received_bytes, 
index c419d6f17a144d3168235db1ed081e53a3113f18..387807ff36daf5e5fdd99fb0a6bb368dd06bc1e1 100644 (file)
@@ -16,10 +16,10 @@ enum fwp_vres_status_t {
 };
 
 /**
- ** \brief Structure of fwp vres 
- **
- ** 
- **/
+ * Structure of FWP vres.
+ *
+ * 
+ */
 struct fwp_vres{
        struct fwp_contract contract;
        struct fwp_msgq tx_queue;