Some Doxygen fixes.
authorTobias Brunner <tobias@strongswan.org>
Mon, 5 Jul 2010 13:04:30 +0000 (15:04 +0200)
committerTobias Brunner <tobias@strongswan.org>
Mon, 5 Jul 2010 13:04:30 +0000 (15:04 +0200)
src/libcharon/plugins/ha/ha_child.h
src/libcharon/plugins/ha/ha_ctl.h
src/libcharon/plugins/ha/ha_dispatcher.h
src/libcharon/plugins/ha/ha_ike.h
src/libcharon/plugins/ha/ha_kernel.h
src/libcharon/plugins/ha/ha_message.h
src/libcharon/plugins/ha/ha_plugin.h
src/libcharon/plugins/ha/ha_segments.h
src/libcharon/plugins/ha/ha_socket.h
src/libcharon/plugins/ha/ha_tunnel.h
src/libstrongswan/plugins/openssl/openssl_util.h

index ea83495..9b4a575 100644 (file)
@@ -54,4 +54,4 @@ struct ha_child_t {
  */
 ha_child_t *ha_child_create(ha_socket_t *socket, ha_tunnel_t *tunnel);
 
-#endif /* HA_CHILD_ @}*/
+#endif /** HA_CHILD_ @}*/
index f33a809..3aae132 100644 (file)
@@ -44,4 +44,4 @@ struct ha_ctl_t {
  */
 ha_ctl_t *ha_ctl_create(ha_segments_t *segments);
 
-#endif /* HA_CTL_ @}*/
+#endif /** HA_CTL_ @}*/
index d2baace..55c0858 100644 (file)
@@ -47,4 +47,4 @@ struct ha_dispatcher_t {
 ha_dispatcher_t *ha_dispatcher_create(ha_socket_t *socket,
                                                                          ha_segments_t *segments);
 
-#endif /* HA_DISPATCHER_ @}*/
+#endif /** HA_DISPATCHER_ @}*/
index 9de210e..9ba8f55 100644 (file)
@@ -54,4 +54,4 @@ struct ha_ike_t {
  */
 ha_ike_t *ha_ike_create(ha_socket_t *socket, ha_tunnel_t *tunnel);
 
-#endif /* HA_IKE_ @}*/
+#endif /** HA_IKE_ @}*/
index b37cc76..b6ad559 100644 (file)
@@ -35,7 +35,7 @@ struct ha_kernel_t {
         *
         * @param host          host to check
         * @param segment       segment
-        * @return                      TRUE if host belongs to segment
+        * @return                      TRUE if host belongs to segment
         */
        bool (*in_segment)(ha_kernel_t *this, host_t *host, u_int segment);
 
@@ -63,8 +63,7 @@ struct ha_kernel_t {
  * Create a ha_kernel instance.
  *
  * @param count                        total number of segments to use
- * @param active               bitmask of initially active segments
  */
 ha_kernel_t *ha_kernel_create(u_int count);
 
-#endif /* HA_KERNEL_ @}*/
+#endif /** HA_KERNEL_ @}*/
index b2bc237..23d6549 100644 (file)
@@ -190,7 +190,6 @@ struct ha_message_t {
 /**
  * Create a new ha_message instance, ready for adding attributes
  *
- * @param version                      protocol version to create a message from
  * @param type                         type of the message
  */
 ha_message_t *ha_message_create(ha_message_type_t type);
@@ -202,4 +201,4 @@ ha_message_t *ha_message_create(ha_message_type_t type);
  */
 ha_message_t *ha_message_parse(chunk_t data);
 
-#endif /* HA_MESSAGE_ @}*/
+#endif /** HA_MESSAGE_ @}*/
index 1ae2fe6..d4d746f 100644 (file)
@@ -44,4 +44,4 @@ struct ha_plugin_t {
        plugin_t plugin;
 };
 
-#endif /* HA_PLUGIN_H_ @}*/
+#endif /** HA_PLUGIN_H_ @}*/
index 6d1cd54..f6ce738 100644 (file)
@@ -108,4 +108,4 @@ ha_segments_t *ha_segments_create(ha_socket_t *socket, ha_kernel_t *kernel,
                                                                  ha_tunnel_t *tunnel, u_int count, u_int node,
                                                                  bool monitor, bool resync);
 
-#endif /* HA_SEGMENTS_ @}*/
+#endif /** HA_SEGMENTS_ @}*/
index 8d398e2..4155e26 100644 (file)
@@ -57,4 +57,4 @@ struct ha_socket_t {
  */
 ha_socket_t *ha_socket_create(char *local, char *remote);
 
-#endif /* HA_SOCKET_ @}*/
+#endif /** HA_SOCKET_ @}*/
index 085fb61..549e330 100644 (file)
@@ -54,4 +54,4 @@ struct ha_tunnel_t {
  */
 ha_tunnel_t *ha_tunnel_create(char *local, char *remote, char *secret);
 
-#endif /* HA_TUNNEL_H_ @}*/
+#endif /** HA_TUNNEL_H_ @}*/
index 405936c..25c692a 100644 (file)
@@ -38,7 +38,7 @@
  * @param hash_type    NID of the hash
  * @param data         the chunk of data to hash
  * @param hash         chunk that contains the hash
- * @return                     TRUE on success, FALSE otherwise
+ * @return                     TRUE on success, FALSE otherwise
  */
 bool openssl_hash_chunk(int hash_type, chunk_t data, chunk_t *hash);
 
@@ -70,8 +70,8 @@ bool openssl_bn_split(chunk_t chunk, BIGNUM *a, BIGNUM *b);
 /**
  * Allocate a chunk using the i2d function of a given object
  *
- * @param type_id      type of the object
- * @param object       object to convert to DER
+ * @param type         type of the object
+ * @param obj          object to convert to DER
  * @returns                    allocated chunk of the object, or chunk_empty
  */
 #define openssl_i2chunk(type, obj) ({ \
@@ -106,7 +106,7 @@ identification_t *openssl_x509_name2id(X509_NAME *name);
 /**
  * Check if an ASN1 oid is a an OID known by libstrongswan.
  *
- * @param object       openssl ASN1 object
+ * @param obj          openssl ASN1 object
  * @returns                    OID, as defined in <asn1/oid.h>
  */
 int openssl_asn1_known_oid(ASN1_OBJECT *obj);