WebSVN – HelenOS – Path Comparison – / – /branches/ Rev 4722 and /branches/ Rev 4723

Ignore whitespace Rev 4722 → Rev 4723

 /branches/network/uspace/srv/net/app/parse.h
 ,7 → 31,7
  */
 /** @file
- *  Generic application parsing functions.
+ *  Generic command line arguments parsing functions.
  */
 #ifndef __NET_APP_PARSE__
 ,10 → 44,11
 void    print_unrecognized( int index, const char * parameter );
 /** Parses the next parameter as an integral number.
- *  Uses the offseted actual parameter if the offset is set or the next one if not.
+ *  The actual parameter is pointed by the index.
+ *  Parses the offseted actual parameter value if the offset is set or the next one if not.
  *  @param argc The total number of the parameters. Input parameter.
  *  @param argv The parameters. Input parameter.
- *  @param index The actual parameter index. Input/output parameter.
+ *  @param index The actual parameter index. The index is incremented by the number of processed parameters. Input/output parameter.
  *  @param value The parsed parameter value. Output parameter.
  *  @param name The parameter name to be printed on errors. Input parameter.
  *  @param offset The value offset in the actual parameter. If not set, the next parameter is parsed instead. Input parameter.
 ,10 → 59,12
 int parse_parameter_int( int argc, char ** argv, int * index, int * value, const char * name, int offset );
 /** Parses the next parameter as a character string.
- *  Uses the offseted actual parameter if the offset is set or the next one if not.
+ *  The actual parameter is pointed by the index.
+ *  Uses the offseted actual parameter value if the offset is set or the next one if not.
+ *  Increments the actual index by the number of processed parameters.
  *  @param argc The total number of the parameters. Input parameter.
  *  @param argv The parameters. Input parameter.
- *  @param index The actual parameter index. Input/output parameter.
+ *  @param index The actual parameter index. The index is incremented by the number of processed parameters. Input/output parameter.
  *  @param value The parsed parameter value. Output parameter.
  *  @param name The parameter name to be printed on errors. Input parameter.
  *  @param offset The value offset in the actual parameter. If not set, the next parameter is parsed instead. Input parameter.
 ,11 → 74,13
 int parse_parameter_string( int argc, char ** argv, int * index, char ** value, const char * name, int offset );
 /** Parses the next named parameter as an integral number.
+ *  The actual parameter is pointed by the index.
  *  Uses the offseted actual parameter if the offset is set or the next one if not.
  *  Translates the parameter using the parse_value function.
+ *  Increments the actual index by the number of processed parameters.
  *  @param argc The total number of the parameters. Input parameter.
  *  @param argv The parameters. Input parameter.
- *  @param index The actual parameter index. Input/output parameter.
+ *  @param index The actual parameter index. The index is incremented by the number of processed parameters. Input/output parameter.
  *  @param value The parsed parameter value. Output parameter.
  *  @param name The parameter name to be printed on errors. Input parameter.
  *  @param offset The value offset in the actual parameter. If not set, the next parameter is parsed instead. Input parameter.

/branches/network/uspace/srv/net/include/arp_interface.h
50,6 → 50,7
/@{/

/** Registers the new device and the requesting protocol service.
* Connects to the network interface layer service.
* Determines the device broadcast address, its address lengths and packet size.
* @param arp_phone The ARP module phone used for (semi)remote calls. Input parameter.
* @param device_id The new device identifier. Input parameter.
69,12 → 70,13

/** Translates the given protocol address to the network interface address.
* Broadcasts the ARP request if the mapping is not found.
* Allocates and returns the needed memory block as the data parameter.
* @param arp_phone The ARP module phone used for (semi)remote calls. Input parameter.
* @param device_id The device identifier. Input parameter.
* @param protocol The requesting protocol service. Input parameter.
* @param address The local requesting protocol address. Input parameter.
* @param translation The translation of the local protocol address. Output parameter.
* @param data The raw translation data container. Output parameter.
* @param data The allocated raw translation data container. Output parameter.
* @returns EOK on success.
* @returns EINVAL if the configuration parameter is NULL.
* @returns EINVAL if the count parameter is zero (0).

 /branches/network/uspace/srv/net/include/net_interface.h
 ,9 → 53,11
 /** Returns the device specific configuration.
  *  Returns the global configuration if the device specific is not found.
+ *  The configuration names are read and the appropriate settings are set instead.
+ *  Call net_free_settings() function to release the returned configuration.
  *  @param net_phone The networking module phone. Input parameter.
  *  @param device_id The device identifier. Input parameter.
- *  @param configuration The configuration and settings. Input/output parameter.
+ *  @param configuration The requested device configuration. The names are read and the appropriate settings are set instead. Input/output parameter.
  *  @param count The configuration entries count. Input parameter.
  *  @param data The configuration and settings data. Input/output parameter.
  *  @returns EOK on success.
 ,8 → 68,10
 int net_get_device_conf_req( int net_phone, device_id_t device_id, measured_string_ref * configuration, size_t count, char ** data );
 /** Returns the global configuration.
+ *  The configuration names are read and the appropriate settings are set instead.
+ *  Call net_free_settings() function to release the returned configuration.
  *  @param net_phone The networking module phone. Input parameter.
- *  @param configuration The configuration and settings. Input/output parameter.
+ *  @param configuration The requested configuration. The names are read and the appropriate settings are set instead. Input/output parameter.
  *  @param count The configuration entries count. Input parameter.
  *  @param data The configuration and settings data. Input/output parameter.
  *  @returns EOK on success.

 /branches/network/uspace/srv/net/il/il_messages.h
 ,11 → 57,11
      */
     NET_IL_RECEIVED,
     /** Packet send message.
-     *  @see ip_send_msg()
+     *  @see il_send_msg()
      */
     NET_IL_SEND,
     /** Packet size message.
-     *  @see ip_packet_size_req()
+     *  @see il_packet_size_req()
      */
     NET_IL_PACKET_SPACE,
     /** Device MTU changed message.

 /branches/network/uspace/srv/net/il/arp/arp.c
 ,9 → 73,10
 arp_globals_t   arp_globals;
 /** Creates new protocol specific data.
- *  @param proto Protocol specific data. Output parameter.
- *  @param service Protocol module service. Input parameter.
- *  @param address Actual protocol device address. Input parameter.
+ *  Allocates and returns the needed memory block as the proto parameter.
+ *  @param proto The allocated protocol specific data. Output parameter.
+ *  @param service The protocol module service. Input parameter.
+ *  @param address The actual protocol device address. Input parameter.
  *  @returns EOK on success.
  *  @returns ENOMEM if there is not enough memory left.
  */
 ,6 → 211,7
     measured_string_ref tmp;
+    // copy the given address for exclusive use
     tmp = measured_string_copy( address );
     if( ERROR_OCCURRED( arp_device_message( device_id, netif, protocol, tmp ))){
         free( tmp->value );

 /branches/network/uspace/srv/net/netif/dp8390/dp8390_port.h
 ,6 → 30,10
  *  @{
  */
+/** @file
+ *  \todo
+ */
 #ifndef __NET_NETIF_DP8390_PORT_H__
 #define __NET_NETIF_DP8390_PORT_H__

 /branches/network/uspace/srv/net/netif/dp8390/ne2000.c
 ,7 → 29,7
  */
 /** @file
- *
+ *  \todo
  */
 #include <stdio.h>

 /branches/network/uspace/srv/net/netif/dp8390/dp8390.c
 ,6 → 28,10
  *  @{
  */
+/** @file
+ *  \todo
+ */
 #include <assert.h>
 #include <errno.h>

/branches/network/uspace/srv/net/netif/dp8390/dp8390_drv.h
31,6 → 31,7
*/

/** @file
* \todo
*/

#ifndef __NET_NETIF_DP8390_DRIVER_H__

 /branches/network/uspace/srv/net/netif/dp8390/ne2000.h
 ,6 → 34,10
  *  @{
  */
+/** @file
+ *  \todo
+ */
 #ifndef __NET_NETIF_NE2000_H__
 #define __NET_NETIF_NE2000_H__

 /branches/network/uspace/srv/net/netif/dp8390/dp8390.h
 ,8 → 28,8
  *  @{
  */
-/**
- * @file
+/** @file
+ *  \todo
  */
 #ifndef __NET_NETIF_DP8390_H__

/branches/network/uspace/srv/net/netif/dp8390/dp8390_module.c
31,6 → 31,7
*/

/** @file
* \todo
*/

#include <assert.h>

Subversion Repositories HelenOS

Compare Revisions

Ignore whitespace Rev 4722 → Rev 4723