/trunk/code/projects/libwireless/lib/wl_basic.c - Diff - Colony - Robotics Club

Revision 1425

updated wireless basic library code and docs

     /**
      * Wrapper for wl_init().
      * Initializes wireless and registers a
      * packet handler function for Basic Group.
      * Initializes wireless and registers a packet handler function for Basic Group.
+     *
      * @param handle_receive function pointer to handler function for Basic Group
      * @return 0 on success, -1 on error
-...
+    }
     /**
      * Wrapper for wl_init().
      * Initializes wireless and registers the default packet handler for Basig Group.
+     *
+     *
      **/
     int wl_basic_init_default( ) {
         return wl_basic_init(&wl_basic_packet_receive_handler);
+    }
     /**
      * Internal function to register a packet group handler for Basic Group
      * Internal function to register a packet group handler for Basic Group.
+     *
      * @param handle_receive function pointer to handler function for Basic Group
      **/
-...
+    }
     /**
      * Send a packet to a single robot in Basic Group
      * Send a packet to a single robot in Basic Group.
+     *
      * @param type Packet type
      * @param data Packet buffer, data you want to send
      * @param len Length of the data buffer in bytes
      * @dest Robot ID of the destination robot
      * @param dest Robot ID of the destination robot
      **/
     void wl_basic_send_robot_packet( char type, char* data, int len, int dest ) {
         wl_send_robot_to_robot_global_packet(WL_BASIC_GROUP, type, data, len, dest, 0);
+    }
     /**
      * Send a packet to all robots in Basic Group
      * Send a packet to all robots in Basic Group.
+     *
      * @param type Packet type
      * @param data Packet buffer, data you want to send
-...
+    }
     /**
      * Default packet handler used if none is specified on init
      * Default packet handler used if none is specified on init.
      * This should not be called directly by any user program.
+     *
      * @param type Packet type
      * @param data Packet buffer, data you received
      * @param source the robot ID of the sending robot
      * @param packet Packet buffer, data you received
      * @param length Length of the data buffer in bytes
      **/
     void wl_basic_packet_receive_handler( char type, int source, unsigned char* packet, int length ) {
         current_packet.new_flag = 1;
         current_packet.type = type;
         current_packet.source = source;
         current_packet.pointer = packet;
         current_packet.data = packet;
         current_packet.length = length;
+    }
     /**
      * Wrapper for wl_do()
      * Wrapper for wl_do() for use with the Basic Wireless group.
      * Can only be called if wl_basic_init_default and your packets
      *  are handled with the default packet handler.
      * To access packet information, use PacketInfo current_packet.
+     *
      * @return pointer to the data of the packet just received
      * @return pointer to the data of the packet just received, 0 if no new packet
      **/
     unsigned char* wl_basic_do( void ) {
     unsigned char* wl_basic_do_default( void ) {
         wl_do();
         if (current_packet.new_flag == 1) {
             current_packet.new_flag = 0;
             return current_packet.pointer;
             return current_packet.data;
+        }
         return 0;
+    }

Also available in: Unified diff

Project

General

Profile

Colony

Revision 1425