diff options
author | Martin Willi <martin@strongswan.org> | 2006-04-20 13:12:35 +0000 |
---|---|---|
committer | Martin Willi <martin@strongswan.org> | 2006-04-20 13:12:35 +0000 |
commit | fcfeb3220fbd4e25b0ac63c541c18e8ae1f30766 (patch) | |
tree | 7ffba119beddd17e8b5b304a60856c1d21660f35 /Source/charon | |
parent | 6b3292da8570edaab0e8e7dd5b2babe0fe983dd2 (diff) | |
download | strongswan-fcfeb3220fbd4e25b0ac63c541c18e8ae1f30766.tar.bz2 strongswan-fcfeb3220fbd4e25b0ac63c541c18e8ae1f30766.tar.xz |
- fixed doxygen build
- seperates now in lib and charon
Diffstat (limited to 'Source/charon')
-rw-r--r-- | Source/charon/config/connection.h | 2 | ||||
-rw-r--r-- | Source/charon/config/policy.h | 2 | ||||
-rw-r--r-- | Source/charon/daemon.h | 90 | ||||
-rw-r--r-- | Source/charon/encoding/payloads/proposal_substructure.h | 10 |
4 files changed, 100 insertions, 4 deletions
diff --git a/Source/charon/config/connection.h b/Source/charon/config/connection.h index 8ecce9d66..39b076411 100644 --- a/Source/charon/config/connection.h +++ b/Source/charon/config/connection.h @@ -156,7 +156,7 @@ struct connection_t { linked_list_t *(*get_proposals) (connection_t *this); /** - * @brief Adds a proposal to the list.. + * @brief Adds a proposal to the list. * * The first added proposal has the highest priority, the last * added the lowest. diff --git a/Source/charon/config/policy.h b/Source/charon/config/policy.h index 78cda1e8b..5a0823758 100644 --- a/Source/charon/config/policy.h +++ b/Source/charon/config/policy.h @@ -79,7 +79,7 @@ struct policy_t { void (*update_my_id) (policy_t *this, identification_t *my_id); /** - * @brief Update others ID. + * @brief Update others id. * * It may be necessary to uptdate others ID, as it * is set to %any or to e.g. *@strongswan.org in diff --git a/Source/charon/daemon.h b/Source/charon/daemon.h index da71fd1d0..57372cc51 100644 --- a/Source/charon/daemon.h +++ b/Source/charon/daemon.h @@ -41,9 +41,11 @@ #include <config/credential_store.h> /** - * @mainpage + * @defgroup charon charon * - * @section Threading Architecture + * @brief IKEv2 keying daemon. + * + * @section Architecture * * All IKEv2 stuff is handled in charon. It uses a newer and more flexible * architecture than pluto. Charon uses a thread-pool, which allows parallel @@ -96,7 +98,83 @@ */ /** + * @defgroup config config + * + * Classes implementing configuration related things. + * + * @ingroup charon + */ + +/** + * @defgroup encoding encoding + * + * Classes used to encode and decode IKEv2 messages. + * + * @ingroup charon + */ + + /** + * @defgroup payloads payloads + * + * Classes representing specific IKEv2 payloads. + * + * @ingroup encoding + */ + +/** + * @defgroup network network + * + * Classes for network relevant stuff. + * + * @ingroup charon + */ + +/** + * @defgroup queues queues + * + * Different kind of queues + * (thread save lists). + * + * @ingroup charon + */ + +/** + * @defgroup jobs jobs + * + * Jobs used in job queue and event queue. + * + * @ingroup queues + */ + +/** + * @defgroup sa sa + * + * Security associations for IKE and IPSec, + * and some helper classes. + * + * @ingroup charon + */ + +/** + * @defgroup states states + * + * Varius states in which an IKE SA can be. + * + * @ingroup sa + */ + +/** + * @defgroup threads threads + * + * Threaded classes, which will do their job alone. + * + * @ingroup charon + */ + +/** * Name of the daemon. + * + * @ingroup charon */ #define DAEMON_NAME "charon" @@ -105,16 +183,22 @@ * * There are several other threads, this defines * only the number of threads in thread_pool_t. + * + * @ingroup charon */ #define NUMBER_OF_WORKING_THREADS 4 /** * UDP Port on which the daemon will listen for incoming traffic. + * + * @ingroup charon */ #define IKEV2_UDP_PORT 500 /** * PID file, in which charon stores its process id + * + * @ingroup charon */ #define PID_FILE "/var/run/charon.pid" @@ -123,6 +207,8 @@ typedef struct daemon_t daemon_t; /** * @brief Main class of daemon, contains some globals. + * + * @ingroup charon */ struct daemon_t { /** diff --git a/Source/charon/encoding/payloads/proposal_substructure.h b/Source/charon/encoding/payloads/proposal_substructure.h index 2270a525b..506d25800 100644 --- a/Source/charon/encoding/payloads/proposal_substructure.h +++ b/Source/charon/encoding/payloads/proposal_substructure.h @@ -173,6 +173,16 @@ struct proposal_substructure_t { */ void (*set_spi) (proposal_substructure_t *this, chunk_t spi); + /** + * @brief Add this proposal_substructure to a proposal. + * + * Since a proposal_t may contain the data of multiple + * proposal_sbustructure_t's, it may be necessary to call + * the function multiple times with the same proposal. + * + * @param this calling proposal_substructure_t object + * @param proposal proposal where the data should be added + */ void (*add_to_proposal) (proposal_substructure_t *this, proposal_t *proposal); /** |