Fixed Doxygen comments after scanning complete src directory
This commit is contained in:
Tobias Brunner
@@ -14,8 +14,8 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup ietf_attrt ietf_attr
|
||||
* @{ @ingroup ietf_attr
|
||||
* @defgroup ietf_attr ietf_attr
|
||||
* @{ @ingroup libimcv
|
||||
*/
|
||||
|
||||
#ifndef IETF_ATTR_H_
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
|
||||
/**
|
||||
* @defgroup ietf_attr_assess_resultt ietf_attr_assess_result
|
||||
* @{ @ingroup ietf
|
||||
* @{ @ingroup ietf_attr
|
||||
*/
|
||||
|
||||
#ifndef IETF_ATTR_ASSESS_RESULT_H_
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
|
||||
/**
|
||||
* @defgroup ietf_attr_attr_requestt ietf_attr_attr_request
|
||||
* @{ @ingroup ietf
|
||||
* @{ @ingroup ietf_attr
|
||||
*/
|
||||
|
||||
#ifndef IETF_ATTR_ATTR_REQUEST_H_
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
|
||||
/**
|
||||
* @defgroup ietf_attr_default_pwd_enabled ietf_attr_default_pwd_enabled
|
||||
* @{ @ingroup ietf
|
||||
* @{ @ingroup ietf_attr
|
||||
*/
|
||||
|
||||
#ifndef IETF_ATTR_PWD_ENABLED_H_
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
|
||||
/**
|
||||
* @defgroup ietf_attr_fwd_enabled ietf_attr_fwd_enabled
|
||||
* @{ @ingroup ietf
|
||||
* @{ @ingroup ietf_attr
|
||||
*/
|
||||
|
||||
#ifndef IETF_ATTR_FWD_ENABLED_H_
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
|
||||
/**
|
||||
* @defgroup ietf_attr_installed_packagest ietf_attr_installed_packages
|
||||
* @{ @ingroup ietf_attr_installed_packages
|
||||
* @{ @ingroup ietf_attr
|
||||
*/
|
||||
|
||||
#ifndef IETF_ATTR_INSTALLED_PACKAGES_H_
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
|
||||
/**
|
||||
* @defgroup ietf_attr_numeric_versiont ietf_attr_numeric_version
|
||||
* @{ @ingroup ietf
|
||||
* @{ @ingroup ietf_attr
|
||||
*/
|
||||
|
||||
#ifndef IETF_ATTR_NUMERIC_VERSION_H_
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
|
||||
/**
|
||||
* @defgroup ietf_attr_op_statust ietf_attr_op_status
|
||||
* @{ @ingroup ietf
|
||||
* @{ @ingroup ietf_attr
|
||||
*/
|
||||
|
||||
#ifndef IETF_ATTR_OP_STATUS_H_
|
||||
@@ -40,7 +40,7 @@ enum op_status_t {
|
||||
};
|
||||
|
||||
extern enum_name_t *op_status_names;
|
||||
|
||||
|
||||
/**
|
||||
* Operational Result type
|
||||
*/
|
||||
@@ -92,7 +92,7 @@ struct ietf_attr_op_status_t {
|
||||
*
|
||||
* @param status Operational Status
|
||||
* @param result Operational Result
|
||||
* @param last_use Time of last use
|
||||
* @param last_use Time of last use
|
||||
*/
|
||||
pa_tnc_attr_t* ietf_attr_op_status_create(u_int8_t status, u_int8_t result,
|
||||
time_t last_use);
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
|
||||
/**
|
||||
* @defgroup ietf_attr_pa_tnc_errort ietf_attr_pa_tnc_error
|
||||
* @{ @ingroup ietf_attr_pa_tnc_error
|
||||
* @{ @ingroup ietf_attr
|
||||
*/
|
||||
|
||||
#ifndef IETF_ATTR_PA_TNC_ERROR_H_
|
||||
@@ -96,7 +96,7 @@ struct ietf_attr_pa_tnc_error_t {
|
||||
*
|
||||
* @param error_code Vendor-specific PA-TNC error code
|
||||
* @param header PA-TNC message header (first 8 bytes)
|
||||
*
|
||||
*
|
||||
*/
|
||||
pa_tnc_attr_t* ietf_attr_pa_tnc_error_create(pen_type_t error_code,
|
||||
chunk_t header);
|
||||
@@ -107,7 +107,7 @@ pa_tnc_attr_t* ietf_attr_pa_tnc_error_create(pen_type_t error_code,
|
||||
* @param error_code Vendor-specifica PA-TNC error code
|
||||
* @param header PA-TNC message header (first 8 bytes)
|
||||
* @param error_offset PA-TNC error offset in bytes
|
||||
*
|
||||
*
|
||||
*/
|
||||
pa_tnc_attr_t* ietf_attr_pa_tnc_error_create_with_offset(pen_type_t error_code,
|
||||
chunk_t header,
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
|
||||
/**
|
||||
* @defgroup ietf_attr_port_filtert ietf_attr_port_filter
|
||||
* @{ @ingroup ietf_attr_port_filter
|
||||
* @{ @ingroup ietf_attr
|
||||
*/
|
||||
|
||||
#ifndef IETF_ATTR_PORT_FILTER_H_
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
|
||||
/**
|
||||
* @defgroup ietf_attr_product_infot ietf_attr_product_info
|
||||
* @{ @ingroup ietf
|
||||
* @{ @ingroup ietf_attr
|
||||
*/
|
||||
|
||||
#ifndef IETF_ATTR_PRODUCT_INFO_H_
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
|
||||
/**
|
||||
* @defgroup ietf_attr_remediation_instrt ietf_attr_remediation_instr
|
||||
* @{ @ingroup ietf
|
||||
* @{ @ingroup ietf_attr
|
||||
*/
|
||||
|
||||
#ifndef IETF_ATTR_REMEDIATION_INSTR_H_
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
|
||||
/**
|
||||
* @defgroup ietf_attr_string_versiont ietf_attr_string_version
|
||||
* @{ @ingroup ietf
|
||||
* @{ @ingroup ietf_attr
|
||||
*/
|
||||
|
||||
#ifndef IETF_ATTR_STRING_VERSION_H_
|
||||
|
||||
@@ -16,7 +16,7 @@
|
||||
/**
|
||||
*
|
||||
* @defgroup imc_agent_t imc_agent
|
||||
* @{ @ingroup imc_agent
|
||||
* @{ @ingroup libimcv_imc
|
||||
*/
|
||||
|
||||
#ifndef IMC_AGENT_H_
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
|
||||
/**
|
||||
* @defgroup imc_msg imc_msg
|
||||
* @{ @ingroup libimcv
|
||||
* @{ @ingroup libimcv_imc
|
||||
*/
|
||||
|
||||
#ifndef IMC_MSG_H_
|
||||
@@ -141,7 +141,6 @@ imc_msg_t* imc_msg_create_from_data(imc_agent_t *agent, imc_state_t *state,
|
||||
* @param connection_id connection ID
|
||||
* @param src_id source IMV ID
|
||||
* @param dst_id destination IMC ID
|
||||
* @param msg_flags PA-TNC message flags
|
||||
* @param msg_vid PA-TNC message vendor ID
|
||||
* @param msg_subtype PA-TNC subtype
|
||||
* @param msg received PA-TNC message blob
|
||||
|
||||
@@ -16,7 +16,7 @@
|
||||
/**
|
||||
*
|
||||
* @defgroup imc_state_t imc_state
|
||||
* @{ @ingroup imc_state
|
||||
* @{ @ingroup libimcv_imc
|
||||
*/
|
||||
|
||||
#ifndef IMC_STATE_H_
|
||||
@@ -68,7 +68,7 @@ struct imc_state_t {
|
||||
/**
|
||||
* Set the maximum size of a PA-TNC message for this TNCCS connection
|
||||
*
|
||||
* @max_msg_len maximum size of a PA-TNC message
|
||||
* @param max_msg_len maximum size of a PA-TNC message
|
||||
*/
|
||||
void (*set_max_msg_len)(imc_state_t *this, u_int32_t max_msg_len);
|
||||
|
||||
|
||||
+10
-1
@@ -15,7 +15,16 @@
|
||||
/**
|
||||
* @defgroup libimcv libimcv
|
||||
*
|
||||
* @defgroup iplugins plugins
|
||||
* @defgroup libimcv_imc imc
|
||||
* @ingroup libimcv
|
||||
*
|
||||
* @defgroup libimcv_imv imv
|
||||
* @ingroup libimcv
|
||||
*
|
||||
* @defgroup pa_tnc pa_tnc
|
||||
* @ingroup libimcv
|
||||
*
|
||||
* @defgroup libimcv_plugins plugins
|
||||
* @ingroup libimcv
|
||||
*
|
||||
* @addtogroup libimcv
|
||||
|
||||
@@ -16,7 +16,7 @@
|
||||
/**
|
||||
*
|
||||
* @defgroup imv_agent_t imv_agent
|
||||
* @{ @ingroup imv_agent
|
||||
* @{ @ingroup libimcv_imv
|
||||
*/
|
||||
|
||||
#ifndef IMV_AGENT_H_
|
||||
|
||||
@@ -16,7 +16,7 @@
|
||||
/**
|
||||
*
|
||||
* @defgroup imv_lang_string_t imv_lang_string
|
||||
* @{ @ingroup imv_lang_string
|
||||
* @{ @ingroup libimcv_imv
|
||||
*/
|
||||
|
||||
#ifndef IMV_LANG_STRING_H_
|
||||
|
||||
@@ -14,8 +14,8 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup imv_msg imv_msg
|
||||
* @{ @ingroup libimcv
|
||||
* @defgroup imv_msg_t imv_msg
|
||||
* @{ @ingroup libimcv_imv
|
||||
*/
|
||||
|
||||
#ifndef IMV_MSG_H_
|
||||
@@ -155,7 +155,6 @@ imv_msg_t* imv_msg_create_from_data(imv_agent_t *agent, imv_state_t *state,
|
||||
* @param connection_id connection ID
|
||||
* @param src_id source IMC ID
|
||||
* @param dst_id destination IMV ID
|
||||
* @param msg_flags PA-TNC message flags
|
||||
* @param msg_vid PA-TNC message vendor ID
|
||||
* @param msg_subtype PA-TNC subtype
|
||||
* @param msg received PA-TNC message blob
|
||||
|
||||
@@ -16,7 +16,7 @@
|
||||
/**
|
||||
*
|
||||
* @defgroup imv_reason_string_t imv_reason_string
|
||||
* @{ @ingroup imv_reason_string
|
||||
* @{ @ingroup libimcv_imv
|
||||
*/
|
||||
|
||||
#ifndef IMV_REASON_STRING_H_
|
||||
|
||||
@@ -16,7 +16,7 @@
|
||||
/**
|
||||
*
|
||||
* @defgroup imv_remediation_string_t imv_remediation_string
|
||||
* @{ @ingroup imv_remediation_string
|
||||
* @{ @ingroup libimcv_imv
|
||||
*/
|
||||
|
||||
#ifndef IMV_REMEDIATION_STRING_H_
|
||||
|
||||
@@ -16,7 +16,7 @@
|
||||
/**
|
||||
*
|
||||
* @defgroup imv_state_t imv_state
|
||||
* @{ @ingroup imv_state
|
||||
* @{ @ingroup libimcv_imv
|
||||
*/
|
||||
|
||||
#ifndef IMV_STATE_H_
|
||||
@@ -66,7 +66,7 @@ struct imv_state_t {
|
||||
/**
|
||||
* Set the maximum size of a PA-TNC message for this TNCCS connection
|
||||
*
|
||||
* @max_msg_len maximum size of a PA-TNC message
|
||||
* @param max_msg_len maximum size of a PA-TNC message
|
||||
*/
|
||||
void (*set_max_msg_len)(imv_state_t *this, u_int32_t max_msg_len);
|
||||
|
||||
|
||||
@@ -14,8 +14,8 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup ita_attrt ita_attr
|
||||
* @{ @ingroup ita_attr
|
||||
* @defgroup ita_attr ita_attr
|
||||
* @{ @ingroup libimcv
|
||||
*/
|
||||
|
||||
#ifndef ITA_ATTR_H_
|
||||
|
||||
@@ -14,8 +14,8 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup ita_attr_angelt ita_attr_angel
|
||||
* @{ @ingroup ita_attr_angel
|
||||
* @defgroup ita_attr_angel ita_attr_angel
|
||||
* @{ @ingroup ita_attr
|
||||
*/
|
||||
|
||||
#ifndef ITA_ATTR_ANGEL_H_
|
||||
|
||||
@@ -14,8 +14,8 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup ita_attr_commandt ita_attr_command
|
||||
* @{ @ingroup ita_attr_command
|
||||
* @defgroup ita_attr_command ita_attr_command
|
||||
* @{ @ingroup ita_attr
|
||||
*/
|
||||
|
||||
#ifndef ITA_ATTR_COMMAND_H_
|
||||
@@ -54,7 +54,7 @@ pa_tnc_attr_t* ita_attr_command_create(char *command);
|
||||
/**
|
||||
* Creates an ita_attr_command_t object from received data
|
||||
*
|
||||
* @param command ITA command string
|
||||
* @param value binary value blob
|
||||
*/
|
||||
pa_tnc_attr_t* ita_attr_command_create_from_data(chunk_t value);
|
||||
|
||||
|
||||
@@ -14,8 +14,8 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup ita_attr_dummyt ita_attr_dummy
|
||||
* @{ @ingroup ita_attr_dummy
|
||||
* @defgroup ita_attr_dummy ita_attr_dummy
|
||||
* @{ @ingroup ita_attr
|
||||
*/
|
||||
|
||||
#ifndef ITA_ATTR_DUMMY_H_
|
||||
@@ -47,14 +47,14 @@ struct ita_attr_dummy_t {
|
||||
/**
|
||||
* Creates an ita_attr_dummy_t object with a given size
|
||||
*
|
||||
* @param size size of dummy attribute value
|
||||
* @param size size of dummy attribute value
|
||||
*/
|
||||
pa_tnc_attr_t* ita_attr_dummy_create(int size);
|
||||
|
||||
/**
|
||||
* Creates an ita_attr_dummy_t object from received data
|
||||
*
|
||||
* @param command ITA command string
|
||||
* @param value binary value blob
|
||||
*/
|
||||
pa_tnc_attr_t* ita_attr_dummy_create_from_data(chunk_t value);
|
||||
|
||||
|
||||
@@ -14,8 +14,8 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup ita_attr_get_settingst ita_attr_get_settings
|
||||
* @{ @ingroup ita_attr_get_settings
|
||||
* @defgroup ita_attr_get_settings ita_attr_get_settings
|
||||
* @{ @ingroup ita_attr
|
||||
*/
|
||||
|
||||
#ifndef ITA_ATTR_GET_SETTINGS_H_
|
||||
|
||||
@@ -14,8 +14,8 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup ita_attr_settingst ita_attr_settings
|
||||
* @{ @ingroup ita_attr_settings
|
||||
* @defgroup ita_attr_settings ita_attr_settings
|
||||
* @{ @ingroup ita_attr
|
||||
*/
|
||||
|
||||
#ifndef ITA_ATTR_SETTINGS_H_
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
|
||||
/**
|
||||
* @defgroup pa_tnc_attr pa_tnc_attr
|
||||
* @{ @ingroup libimcv
|
||||
* @{ @ingroup pa_tnc
|
||||
*/
|
||||
|
||||
#ifndef PA_TNC_ATTR_H_
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
|
||||
/**
|
||||
* @defgroup pa_tnc_attr_manager pa_tnc_attr_manager
|
||||
* @{ @ingroup libimcv
|
||||
* @{ @ingroup pa_tnc
|
||||
*/
|
||||
|
||||
#ifndef PA_TNC_ATTR_MANAGER_H_
|
||||
@@ -56,7 +56,7 @@ struct pa_tnc_attr_manager_t {
|
||||
* Return the PA-TNC attribute names for a given vendor ID
|
||||
*
|
||||
* @param vendor_id Private Enterprise Number (PEN)
|
||||
* @return PA-TNC attribute names if found, NULL else
|
||||
* @return PA-TNC attribute names if found, NULL else
|
||||
*/
|
||||
enum_name_t* (*get_names)(pa_tnc_attr_manager_t *this, pen_t vendor_id);
|
||||
|
||||
@@ -66,7 +66,7 @@ struct pa_tnc_attr_manager_t {
|
||||
* @param vendor_id Private Enterprise Number (PEN)
|
||||
* @param type PA-TNC attribute type
|
||||
* @param value PA-TNC attribute value as encoded data
|
||||
* @return PA-TNC attribute object if supported, NULL else
|
||||
* @return PA-TNC attribute object if supported, NULL else
|
||||
*/
|
||||
pa_tnc_attr_t* (*create)(pa_tnc_attr_manager_t *this, pen_t vendor_id,
|
||||
u_int32_t type, chunk_t value);
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
|
||||
/**
|
||||
* @defgroup pa_tnc_msg pa_tnc_msg
|
||||
* @{ @ingroup libimcv
|
||||
* @{ @ingroup pa_tnc
|
||||
*/
|
||||
|
||||
#ifndef PA_TNC_MSG_H_
|
||||
|
||||
@@ -14,9 +14,11 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup imc_os imc_os
|
||||
* @ingroup libimcv_plugins
|
||||
*
|
||||
* @defgroup imc_os_state_t imc_os_state
|
||||
* @{ @ingroup imc_os_state
|
||||
* @{ @ingroup imc_os
|
||||
*/
|
||||
|
||||
#ifndef IMC_OS_STATE_H_
|
||||
|
||||
@@ -13,9 +13,11 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup imc_scanner imc_scanner
|
||||
* @ingroup libimcv_plugins
|
||||
*
|
||||
* @defgroup imc_scanner_state_t imc_scanner_state
|
||||
* @{ @ingroup imc_scanner_state
|
||||
* @{ @ingroup imc_scanner
|
||||
*/
|
||||
|
||||
#ifndef IMC_SCANNER_STATE_H_
|
||||
|
||||
@@ -13,9 +13,11 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup imc_test imc_test
|
||||
* @ingroup libimcv_plugins
|
||||
*
|
||||
* @defgroup imc_test_state_t imc_test_state
|
||||
* @{ @ingroup imc_test_state
|
||||
* @{ @ingroup imc_test
|
||||
*/
|
||||
|
||||
#ifndef IMC_TEST_STATE_H_
|
||||
|
||||
@@ -14,9 +14,8 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
*
|
||||
* @defgroup imv_os_database_t imv_os_database
|
||||
* @{ @ingroup imv_os_database
|
||||
* @{ @ingroup imv_os
|
||||
*/
|
||||
|
||||
#ifndef IMV_OS_DATABASE_H_
|
||||
|
||||
@@ -14,9 +14,11 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup imv_os imv_os
|
||||
* @ingroup libimcv_plugins
|
||||
*
|
||||
* @defgroup imv_os_state_t imv_os_state
|
||||
* @{ @ingroup imv_os_state
|
||||
* @{ @ingroup imv_os
|
||||
*/
|
||||
|
||||
#ifndef IMV_OS_STATE_H_
|
||||
@@ -61,7 +63,7 @@ struct imv_os_state_t {
|
||||
* @param type OS type (enumerated)
|
||||
* @param name OS name (string)
|
||||
* @param version OS version
|
||||
* @return OS name & version as a concatenated string
|
||||
* @return OS name & version as a concatenated string
|
||||
*/
|
||||
char* (*get_info)(imv_os_state_t *this, os_type_t *os_type,
|
||||
chunk_t *name, chunk_t *version);
|
||||
|
||||
@@ -13,9 +13,11 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup imv_scanner imv_scanner
|
||||
* @ingroup libimcv_plugins
|
||||
*
|
||||
* @defgroup imv_scanner_state_t imv_scanner_state
|
||||
* @{ @ingroup imv_scanner_state
|
||||
* @{ @ingroup imv_scanner
|
||||
*/
|
||||
|
||||
#ifndef IMV_SCANNER_STATE_H_
|
||||
|
||||
@@ -13,9 +13,11 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup imv_test imv_test
|
||||
* @ingroup libimcv_plugins
|
||||
*
|
||||
* @defgroup imv_test_state_t imv_test_state
|
||||
* @{ @ingroup imv_test_state
|
||||
* @{ @ingroup imv_test
|
||||
*/
|
||||
|
||||
#ifndef IMV_TEST_STATE_H_
|
||||
|
||||
Reference in New Issue
Block a user