aboutsummaryrefslogtreecommitdiffstats
path: root/src/dumm
diff options
context:
space:
mode:
authorMartin Willi <martin@strongswan.org>2009-05-11 17:24:51 +0200
committerMartin Willi <martin@strongswan.org>2009-05-11 17:24:51 +0200
commitdb879fdfac28ef005d2320d0e507c15a12cfd657 (patch)
treeae31eb5907c75fb3e69f8f6e5ce574f9256740ad /src/dumm
parent5d47f284b8574b3375809057b3836ec1be0a1d69 (diff)
downloadstrongswan-db879fdfac28ef005d2320d0e507c15a12cfd657.tar.bz2
strongswan-db879fdfac28ef005d2320d0e507c15a12cfd657.tar.xz
removed @brief doxygen keywords
Diffstat (limited to 'src/dumm')
-rw-r--r--src/dumm/bridge.h14
-rw-r--r--src/dumm/cowfs.h8
-rw-r--r--src/dumm/dumm.h22
-rw-r--r--src/dumm/guest.h30
-rw-r--r--src/dumm/iface.h16
-rw-r--r--src/dumm/mconsole.h10
6 files changed, 50 insertions, 50 deletions
diff --git a/src/dumm/bridge.h b/src/dumm/bridge.h
index 79a0a3a72..37b22a03e 100644
--- a/src/dumm/bridge.h
+++ b/src/dumm/bridge.h
@@ -24,19 +24,19 @@ typedef struct bridge_t bridge_t;
#include "iface.h"
/**
- * @brief Interface in a guest, connected to a tap device on the host.
+ * Interface in a guest, connected to a tap device on the host.
*/
struct bridge_t {
/**
- * @brief Get the name of the bridge.
+ * Get the name of the bridge.
*
* @return name of the bridge
*/
char* (*get_name)(bridge_t *this);
/**
- * @brief Add an interface to a bridge.
+ * Add an interface to a bridge.
*
* @param iface interface to add
* @return TRUE if interface added
@@ -44,7 +44,7 @@ struct bridge_t {
bool (*connect_iface)(bridge_t *this, iface_t *iface);
/**
- * @brief Remove an interface from a bridge.
+ * Remove an interface from a bridge.
*
* @param iface interface to remove
* @return TRUE if interface removed
@@ -52,20 +52,20 @@ struct bridge_t {
bool (*disconnect_iface)(bridge_t *this, iface_t *iface);
/**
- * @brief Create an enumerator over all interfaces.
+ * Create an enumerator over all interfaces.
*
* @return enumerator over iface_t's
*/
enumerator_t* (*create_iface_enumerator)(bridge_t *this);
/**
- * @brief Destroy a bridge
+ * Destroy a bridge
*/
void (*destroy) (bridge_t *this);
};
/**
- * @brief Create a new bridge.
+ * Create a new bridge.
*
* @param name name of the bridge to create
* @return bridge, NULL if failed
diff --git a/src/dumm/cowfs.h b/src/dumm/cowfs.h
index 419197dd6..bb589f158 100644
--- a/src/dumm/cowfs.h
+++ b/src/dumm/cowfs.h
@@ -21,13 +21,13 @@
typedef struct cowfs_t cowfs_t;
/**
- * @brief cowfs - Copy on write FUSE filesystem.
+ * cowfs - Copy on write FUSE filesystem.
*
*/
struct cowfs_t {
/**
- * @brief Set an additional copy on write overlay.
+ * Set an additional copy on write overlay.
*
* @param path path of the overlay
* @return FALSE if failed
@@ -35,13 +35,13 @@ struct cowfs_t {
bool (*set_overlay)(cowfs_t *this, char *path);
/**
- * @brief Stop, umount and destroy a cowfs FUSE filesystem.
+ * Stop, umount and destroy a cowfs FUSE filesystem.
*/
void (*destroy) (cowfs_t *this);
};
/**
- * @brief Mount a cowfs FUSE filesystem.
+ * Mount a cowfs FUSE filesystem.
*
* @param master read only master file system directory
* @param host copy on write host directory
diff --git a/src/dumm/dumm.h b/src/dumm/dumm.h
index b3682595e..5f2e0542a 100644
--- a/src/dumm/dumm.h
+++ b/src/dumm/dumm.h
@@ -28,14 +28,14 @@
typedef struct dumm_t dumm_t;
/**
- * @brief dumm - Dynamic Uml Mesh Modeler
+ * dumm - Dynamic Uml Mesh Modeler
*
* Controls a group of UML guests and their networks.
*/
struct dumm_t {
/**
- * @brief Starts a new UML guest
+ * Starts a new UML guest
*
* @param name name of the guest
* @param kernel UML kernel to use for guest
@@ -47,21 +47,21 @@ struct dumm_t {
char *master, char *args);
/**
- * @brief Create an enumerator over all guests.
+ * Create an enumerator over all guests.
*
* @return enumerator over guest_t's
*/
enumerator_t* (*create_guest_enumerator) (dumm_t *this);
/**
- * @brief Delete a guest from disk.
+ * Delete a guest from disk.
*
* @param guest guest to destroy
*/
void (*delete_guest) (dumm_t *this, guest_t *guest);
/**
- * @brief Create a new bridge.
+ * Create a new bridge.
*
* @param name name of the bridge to create
* @return created bridge
@@ -69,21 +69,21 @@ struct dumm_t {
bridge_t* (*create_bridge)(dumm_t *this, char *name);
/**
- * @brief Create an enumerator over all bridges.
+ * Create an enumerator over all bridges.
*
* @return enumerator over bridge_t's
*/
enumerator_t* (*create_bridge_enumerator)(dumm_t *this);
/**
- * @brief Delete a bridge.
+ * Delete a bridge.
*
* @param bridge bridge to destroy
*/
void (*delete_bridge) (dumm_t *this, bridge_t *bridge);
/**
- * @brief Loads a template, create a new one if it does not exist.
+ * Loads a template, create a new one if it does not exist.
*
* @param name dir to the template, NULL to close
* @return FALSE if load/create failed
@@ -91,20 +91,20 @@ struct dumm_t {
bool (*load_template)(dumm_t *this, char *dir);
/**
- * @brief Create an enumerator over all available templates.
+ * Create an enumerator over all available templates.
*
* @return enumerator over char*
*/
enumerator_t* (*create_template_enumerator)(dumm_t *this);
/**
- * @brief stop all guests and destroy the modeler
+ * stop all guests and destroy the modeler
*/
void (*destroy) (dumm_t *this);
};
/**
- * @brief Create a group of UML hosts and networks.
+ * Create a group of UML hosts and networks.
*
* @param dir directory to create guests/load from, NULL for cwd
* @return created UML group, or NULL if failed.
diff --git a/src/dumm/guest.h b/src/dumm/guest.h
index 19dc8a8bf..a1e4966ac 100644
--- a/src/dumm/guest.h
+++ b/src/dumm/guest.h
@@ -26,7 +26,7 @@ typedef struct guest_t guest_t;
#include "iface.h"
/**
- * @brief State of a guest (started, stopped, ...)
+ * State of a guest (started, stopped, ...)
*/
enum guest_state_t {
/** guest kernel not running at all */
@@ -68,33 +68,33 @@ typedef pid_t (*invoke_function_t)(void *data, guest_t *guest,
typedef void (*idle_function_t)(void);
/**
- * @brief A guest is a UML instance running on the host.
+ * A guest is a UML instance running on the host.
**/
struct guest_t {
/**
- * @brief Get the name of this guest.
+ * Get the name of this guest.
*
* @return name of the guest
*/
char* (*get_name) (guest_t *this);
/**
- * @brief Get the process ID of the guest child process.
+ * Get the process ID of the guest child process.
*
* @return name of the guest
*/
pid_t (*get_pid) (guest_t *this);
/**
- * @brief Get the state of the guest (stopped, started, etc.).
+ * Get the state of the guest (stopped, started, etc.).
*
* @return guests state
*/
guest_state_t (*get_state)(guest_t *this);
/**
- * @brief Start the guest.
+ * Start the guest.
*
* @param invoke UML guest invocation function
* @param data data to pass back to invoke function
@@ -105,14 +105,14 @@ struct guest_t {
idle_function_t idle);
/**
- * @brief Kill the guest.
+ * Kill the guest.
*
* @param idle idle function to call while waiting to termination
*/
void (*stop) (guest_t *this, idle_function_t idle);
/**
- * @brief Create a new interface in the current scenario.
+ * Create a new interface in the current scenario.
*
* @param name name of the interface in the guest
* @return created interface, or NULL if failed
@@ -120,21 +120,21 @@ struct guest_t {
iface_t* (*create_iface)(guest_t *this, char *name);
/**
- * @brief Destroy an interface on guest.
+ * Destroy an interface on guest.
*
* @param iface interface to destroy
*/
void (*destroy_iface)(guest_t *this, iface_t *iface);
/**
- * @brief Create an enumerator over all guest interfaces.
+ * Create an enumerator over all guest interfaces.
*
* @return enumerator over iface_t's
*/
enumerator_t* (*create_iface_enumerator)(guest_t *this);
/**
- * @brief Set the template COWFS overlay to use.
+ * Set the template COWFS overlay to use.
*
* @param parent parent directory where template diff should point to
* @return FALSE if failed
@@ -172,18 +172,18 @@ struct guest_t {
void *data, char *cmd, ...);
/**
- * @brief Called whenever a SIGCHILD for the guests PID is received.
+ * Called whenever a SIGCHILD for the guests PID is received.
*/
void (*sigchild)(guest_t *this);
/**
- * @brief Close and destroy a guest with all interfaces
+ * Close and destroy a guest with all interfaces
*/
void (*destroy) (guest_t *this);
};
/**
- * @brief Create a new, unstarted guest.
+ * Create a new, unstarted guest.
*
* @param parent parent directory to create the guest in
* @param name name of the guest to create
@@ -196,7 +196,7 @@ guest_t *guest_create(char *parent, char *name, char *kernel,
char *master, char *args);
/**
- * @brief Load a guest created with guest_create().
+ * Load a guest created with guest_create().
*
* @param parent parent directory to look for a guest
* @param name name of the guest directory
diff --git a/src/dumm/iface.h b/src/dumm/iface.h
index 54a0554c0..7aef95c01 100644
--- a/src/dumm/iface.h
+++ b/src/dumm/iface.h
@@ -29,19 +29,19 @@ typedef struct iface_t iface_t;
#include "guest.h"
/**
- * @brief Interface in a guest, connected to a tap device on the host.
+ * Interface in a guest, connected to a tap device on the host.
*/
struct iface_t {
/**
- * @brief Get the interface name in the guest (e.g. eth0).
+ * Get the interface name in the guest (e.g. eth0).
*
* @return guest interface name
*/
char* (*get_guestif)(iface_t *this);
/**
- * @brief Get the interface name at the host (e.g. tap0).
+ * Get the interface name at the host (e.g. tap0).
*
* @return host interface (tap device) name
*/
@@ -71,34 +71,34 @@ struct iface_t {
bool (*delete_address)(iface_t *this, host_t *addr);
/**
- * @brief Set the bridge this interface is attached to.
+ * Set the bridge this interface is attached to.
*
* @param bridge assigned bridge, or NULL for none
*/
void (*set_bridge)(iface_t *this, bridge_t *bridge);
/**
- * @brief Get the bridge this iface is connected, or NULL.
+ * Get the bridge this iface is connected, or NULL.
*
* @return connected bridge, or NULL
*/
bridge_t* (*get_bridge)(iface_t *this);
/**
- * @brief Get the guest this iface belongs to.
+ * Get the guest this iface belongs to.
*
* @return guest of this iface
*/
guest_t* (*get_guest)(iface_t *this);
/**
- * @brief Destroy an interface
+ * Destroy an interface
*/
void (*destroy) (iface_t *this);
};
/**
- * @brief Create a new interface for a guest
+ * Create a new interface for a guest
*
* @param name name of the interface in the guest
* @param guest guest this iface is connecting
diff --git a/src/dumm/mconsole.h b/src/dumm/mconsole.h
index e8493b5bb..a4d93e48e 100644
--- a/src/dumm/mconsole.h
+++ b/src/dumm/mconsole.h
@@ -21,12 +21,12 @@
typedef struct mconsole_t mconsole_t;
/**
- * @brief UML mconsole, change running UML configuration using mconsole.
+ * UML mconsole, change running UML configuration using mconsole.
*/
struct mconsole_t {
/**
- * @brief Create a guest interface and connect it to tap host interface.
+ * Create a guest interface and connect it to tap host interface.
*
* @param guest name of the interface to create in the guest
* @param host name of the tap device to connect guest to
@@ -35,7 +35,7 @@ struct mconsole_t {
bool (*add_iface)(mconsole_t *this, char *guest, char *host);
/**
- * @brief Delete a guest interface.
+ * Delete a guest interface.
*
* @param guest name of the interface to delete on the guest
* @return TRUE if interface deleted
@@ -54,13 +54,13 @@ struct mconsole_t {
char *cmd);
/**
- * @brief Destroy the mconsole instance
+ * Destroy the mconsole instance
*/
void (*destroy) (mconsole_t *this);
};
/**
- * @brief Create a new mconsole connection to a guest.
+ * Create a new mconsole connection to a guest.
*
* Waits for a notification from the guest through the notify socket and tries
* to connect to the mconsole socket supplied in the received notification.