Fixed some Doxygen warnings.

This commit is contained in:
Tobias Brunner
2010-03-24 15:45:06 +01:00
parent 037fb02493
commit d7e977aced
3 changed files with 18 additions and 18 deletions
+2 -2
View File
@@ -44,7 +44,7 @@ struct listener_t {
* @param ike_sa IKE_SA associated to the event * @param ike_sa IKE_SA associated to the event
* @param format printf() style format string * @param format printf() style format string
* @param args vprintf() style va_list argument list * @param args vprintf() style va_list argument list
" @return TRUE to stay registered, FALSE to unregister * @return TRUE to stay registered, FALSE to unregister
*/ */
bool (*log)(listener_t *this, debug_t group, level_t level, int thread, bool (*log)(listener_t *this, debug_t group, level_t level, int thread,
ike_sa_t *ike_sa, char* format, va_list args); ike_sa_t *ike_sa, char* format, va_list args);
@@ -55,7 +55,7 @@ struct listener_t {
* @param ike_sa IKE_SA associated to the alert, if any * @param ike_sa IKE_SA associated to the alert, if any
* @param alert kind of alert * @param alert kind of alert
* @param ... alert specific argument list * @param ... alert specific argument list
" @return TRUE to stay registered, FALSE to unregister * @return TRUE to stay registered, FALSE to unregister
*/ */
bool (*alert)(listener_t *this, ike_sa_t *ike_sa, bool (*alert)(listener_t *this, ike_sa_t *ike_sa,
alert_t alert, va_list args); alert_t alert, va_list args);
+2 -2
View File
@@ -100,8 +100,8 @@ cp_payload_t *cp_payload_create();
/** /**
* Creates an cp_payload_t with type and value * Creates an cp_payload_t with type and value
* *
* @param type type of configuration payload to create * @param config_type type of configuration payload to create
* @return created configuration payload * @return created configuration payload
*/ */
cp_payload_t *cp_payload_create_type(config_type_t config_type); cp_payload_t *cp_payload_create_type(config_type_t config_type);
+14 -14
View File
@@ -74,8 +74,8 @@ struct traffic_selector_t {
* *
* @param other traffic selector to compare * @param other traffic selector to compare
* @return * @return
* - created subset of them * - created subset of them
* - or NULL if no match between this and other * - or NULL if no match between this and other
*/ */
traffic_selector_t *(*get_subset) (traffic_selector_t *this, traffic_selector_t *(*get_subset) (traffic_selector_t *this,
traffic_selector_t *other); traffic_selector_t *other);
@@ -173,7 +173,7 @@ struct traffic_selector_t {
* Compare two traffic selectors for equality. * Compare two traffic selectors for equality.
* *
* @param other ts to compare with this * @param other ts to compare with this
* @return TRUE if equal, FALSE otherwise * @return TRUE if equal, FALSE otherwise
*/ */
bool (*equals) (traffic_selector_t *this, traffic_selector_t *other); bool (*equals) (traffic_selector_t *this, traffic_selector_t *other);
@@ -215,15 +215,15 @@ struct traffic_selector_t {
/** /**
* Create a new traffic selector using human readable params. * Create a new traffic selector using human readable params.
* *
* @param protocol protocol for this ts, such as TCP or UDP * @param protocol protocol for this ts, such as TCP or UDP
* @param type type of following addresses, such as TS_IPV4_ADDR_RANGE * @param type type of following addresses, such as TS_IPV4_ADDR_RANGE
* @param from_addr start of address range as string * @param from_addr start of address range as string
* @param from_port port number in host order * @param from_port port number in host order
* @param to_addr end of address range as string * @param to_addr end of address range as string
* @param to_port port number in host order * @param to_port port number in host order
* @return * @return
* - traffic_selector_t object * - traffic_selector_t object
* - NULL if invalid address strings/protocol * - NULL if invalid address strings/protocol
*/ */
traffic_selector_t *traffic_selector_create_from_string( traffic_selector_t *traffic_selector_create_from_string(
u_int8_t protocol, ts_type_t type, u_int8_t protocol, ts_type_t type,
@@ -237,11 +237,11 @@ traffic_selector_t *traffic_selector_create_from_string(
* But the parser gives us this data in this format, so we * But the parser gives us this data in this format, so we
* don't have to convert twice. * don't have to convert twice.
* *
* @param protocol protocol for this ts, such as TCP or UDP * @param protocol protocol for this ts, such as TCP or UDP
* @param type type of following addresses, such as TS_IPV4_ADDR_RANGE * @param type type of following addresses, such as TS_IPV4_ADDR_RANGE
* @param from_addr start of address range, network order * @param from_address start of address range, network order
* @param from_port port number, host order * @param from_port port number, host order
* @param to_addr end of address range, network order * @param to_address end of address range, network order
* @param to_port port number, host order * @param to_port port number, host order
* @return traffic_selector_t object * @return traffic_selector_t object
*/ */
@@ -273,11 +273,11 @@ traffic_selector_t *traffic_selector_create_from_rfc3779_format(ts_type_t type,
* *
* @param net subnet to use * @param net subnet to use
* @param netbits size of the subnet, as used in e.g. 192.168.0.0/24 notation * @param netbits size of the subnet, as used in e.g. 192.168.0.0/24 notation
* @param protocol protocol for this ts, such as TCP or UDP * @param protocol protocol for this ts, such as TCP or UDP
* @param port port number, host order * @param port port number, host order
* @return * @return
* - traffic_selector_t object * - traffic_selector_t object
* - NULL if address family of net not supported * - NULL if address family of net not supported
*/ */
traffic_selector_t *traffic_selector_create_from_subnet( traffic_selector_t *traffic_selector_create_from_subnet(
host_t *net, u_int8_t netbits, host_t *net, u_int8_t netbits,
@@ -295,8 +295,8 @@ traffic_selector_t *traffic_selector_create_from_subnet(
* @param from_port start of allowed port range * @param from_port start of allowed port range
* @param to_port end of range * @param to_port end of range
* @return * @return
* - traffic_selector_t object * - traffic_selector_t object
* - NULL if type not supported * - NULL if type not supported
*/ */
traffic_selector_t *traffic_selector_create_dynamic(u_int8_t protocol, traffic_selector_t *traffic_selector_create_dynamic(u_int8_t protocol,
u_int16_t from_port, u_int16_t to_port); u_int16_t from_port, u_int16_t to_port);