Skip to content

Commit

Permalink
Clear doxy warnings
Browse files Browse the repository at this point in the history
  • Loading branch information
mattmundell authored and a-h-abdelsalam committed Jan 8, 2024
1 parent 3752550 commit b773032
Show file tree
Hide file tree
Showing 8 changed files with 31 additions and 33 deletions.
6 changes: 3 additions & 3 deletions base/hosts.c
Original file line number Diff line number Diff line change
Expand Up @@ -1319,7 +1319,7 @@ gvm_hosts_next (gvm_hosts_t *hosts)
* @brief Move the current gvm_host_t from a gvm_hosts_t structure to
* the end of the hosts list.
*
* @param[in/out] hosts gvm_hosts_t structure which hosts must be
* @param[in,out] hosts gvm_hosts_t structure which hosts must be
* rearange. The hosts->current index points to the last used hosts and
* gvm_hosts_next() must be called to get the next host in the list.
*
Expand Down Expand Up @@ -1553,7 +1553,7 @@ gvm_vhosts_exclude (gvm_host_t *host, const char *excluded_str)
* Not to be used while iterating over the single hosts as it resets the
* iterator.
*
* @param[in/out] hosts The hosts collection from which to exclude.
* @param[in,out] hosts The hosts collection from which to exclude.
* @param[in] excluded_str String of hosts to exclude.
* @param[in] max_hosts Max number of hosts in hosts_str. 0 means unlimited.
*
Expand Down Expand Up @@ -1626,7 +1626,7 @@ gvm_hosts_exclude_with_max (gvm_hosts_t *hosts, const char *excluded_str,
/**
* @brief Returns a list of hosts after a host authorization check.
*
* @param[in/out] hosts The hosts collection from which to exclude.
* @param[in,out] hosts The hosts collection from which to exclude.
* @param[in] deny_hosts_str String of denied hosts. This hosts will be
* removed from the hosts list
* @param[in] allow_hosts_str String of allow hosts. This hosts will be kept
Expand Down
11 changes: 5 additions & 6 deletions base/nvti.c
Original file line number Diff line number Diff line change
Expand Up @@ -454,8 +454,7 @@ nvti_add_vtref (nvti_t *vt, vtref_t *ref)
* @brief Add a severity to the VT Info.
*
* @param vt The VT Info structure.
*
* @param ref The VT severity to add.
* @param s The VT severity to add.
*
* @return 0 for success. Anything else indicates an error.
*/
Expand Down Expand Up @@ -1305,7 +1304,7 @@ nvti_put_name (nvti_t *n, gchar *name)
*
* @param n The NVT Info structure.
*
* @param solution The summary to set. A copy will be created from this.
* @param summary The summary to set. A copy will be created from this.
*
* @return 0 for success. Anything else indicates an error.
*/
Expand All @@ -1325,7 +1324,7 @@ nvti_set_summary (nvti_t *n, const gchar *summary)
*
* @param n The NVT Info structure.
*
* @param solution The summary to set. The string will be used directly.
* @param summary The summary to set. The string will be used directly.
*
* @return 0 for success. Anything else indicates an error.
*/
Expand Down Expand Up @@ -1425,7 +1424,7 @@ nvti_put_affected (nvti_t *n, gchar *affected)
*
* @param n The NVT Info structure.
*
* @param affected The impact text to set. A copy will be created from this.
* @param impact The impact text to set. A copy will be created from this.
*
* @return 0 for success. Anything else indicates an error.
*/
Expand All @@ -1445,7 +1444,7 @@ nvti_set_impact (nvti_t *n, const gchar *impact)
*
* @param n The NVT Info structure.
*
* @param affected The impact text to set. The string will be used directly.
* @param impact The impact text to set. The string will be used directly.
*
* @return 0 for success. Anything else indicates an error.
*/
Expand Down
8 changes: 4 additions & 4 deletions gmp/gmp.c
Original file line number Diff line number Diff line change
Expand Up @@ -348,10 +348,10 @@ gmp_authenticate (gnutls_session_t *session, const char *username,
/**
* @brief Authenticate with the manager.
*
* @param[in] session Pointer to GNUTLS session.
* @param[in] opts Struct containing the options to apply.
* @param[out] opts Additional account information if authentication
* was successful.
* @param[in] session Pointer to GNUTLS session.
* @param[in,out] opts In: Struct containing the options to apply.
* Out: Additional account information if authentication
* was successful.
*
* @return 0 on success, 1 if manager closed connection, 2 if auth failed,
* 3 on timeout, -1 on error.
Expand Down
8 changes: 5 additions & 3 deletions osp/osp.c
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ osp_send_command (osp_connection_t *connection, entity_t *response,
* @brief Send a command to an OSP server.
*
* @param[in] connection Connection to OSP server.
* @param[out] response Response from OSP server.
* @param[out] str Response from OSP server.
* @param[in] fmt OSP Command to send.
*
* @return 0 and response, 1 if error.
Expand Down Expand Up @@ -673,7 +673,7 @@ osp_get_vts_ext (osp_connection_t *connection, osp_get_vts_opts_t opts,
*
* @param[in] connection Connection to an OSP server.
* @param[in] opts Struct containing the options to apply.
* @param[out] vts VTs.
* @param[out] str Response.
*
* @return 0 if success, 1 if error.
*/
Expand Down Expand Up @@ -811,7 +811,7 @@ osp_get_performance_ext (osp_connection_t *connection,
* @brief Get a scan status from an OSP server
*
* @param[in] connection Connection to an OSP server.
* @param[in] scan_id ID of scan to get.
* @param[in] opts Struct containing the options to apply.
* @param[out] error Pointer to error, if any.
*
* @return Osp scan status
Expand Down Expand Up @@ -1682,6 +1682,8 @@ osp_credential_set_auth_data (osp_credential_t *credential, const char *name,
* @param[in] ports The ports of the target.
* @param[in] exclude_hosts The excluded hosts of the target.
* @param[in] alive_test The alive test method of the target.
* @param[in] reverse_lookup_unify Lookup flag.
* @param[in] reverse_lookup_only Lookup flag.
*
* @return The newly allocated osp_target_t.
*/
Expand Down
8 changes: 5 additions & 3 deletions util/kb.h
Original file line number Diff line number Diff line change
Expand Up @@ -471,13 +471,15 @@ kb_item_add_str_unique (kb_t kb, const char *name, const char *str, size_t len,

/**
* @brief Insert (append) a new unique and volatile entry under a given name.
*
* @param[in] kb Reference to a kb_t to initialize.
* @param[in] name Item name.
* @param[in] val Item value.
* @param[in] expire Item expire.
* @param[in] str String to add.
* @param[in] len Value length. Used for blobs.
* @param[in] expire Item expire.
* @param[in] pos Which position the value is appended to. 0 for right, 1 for
* left position in the list.
* left position in the list.
*
* @return 0 on success, -1 on error.
*/
static inline int
Expand Down
14 changes: 7 additions & 7 deletions util/mqtt.c
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ static gboolean mqtt_initialized = FALSE;
/**
* @brief Set the global init status.
* @param Status Status of initialization.
* @param status Status of initialization.
*/
static void
mqtt_set_initialized_status (gboolean status)
Expand Down Expand Up @@ -552,7 +552,7 @@ mqtt_publish_single_message (const char *server_uri_in, const char *topic,
*
* @param server_uri_in Server URI
* @param username_in Username
* @param password_in Password
* @param passwd_in Password
* @param topic Topic to publish to
* @param msg Message to publish
*
Expand Down Expand Up @@ -626,9 +626,9 @@ mqtt_publish_single_message_auth (const char *server_uri_in,
* To be able to subscribe to a topic the client needs to be connected to a
* broker.
*
* @param mqtt_t contains the mqtt client
* @param qos quality of service of messages within topic
* @param topic Topic to subscribe to
* @param mqtt contains the mqtt client
* @param qos quality of service of messages within topic
* @param topic Topic to subscribe to
*
* @return 0 on success, -1 when given mqtt is not useable, -2 when subscription
* failed.
Expand Down Expand Up @@ -679,8 +679,8 @@ mqtt_subscribe (const char *topic)
*
* This function unsubscribes given client from a given topic.
*
* @param mqtt_t contains the mqtt client
* @param topic Topic to unsubscribe from
* @param mqtt contains the mqtt client
* @param topic Topic to unsubscribe from
*
* @return 0 on success, -1 when given mqtt is not useable, -2 when unsubscribe
* failed.
Expand Down
2 changes: 0 additions & 2 deletions util/serverutils.c
Original file line number Diff line number Diff line change
Expand Up @@ -500,8 +500,6 @@ gvm_server_close (int socket, gnutls_session_t session)
* @brief Close a server connection and its socket.
*
* @param[in] connection Connection.
*
* @return 0 on success, -1 on error.
*/
void
gvm_connection_close (gvm_connection_t *connection)
Expand Down
7 changes: 2 additions & 5 deletions util/xmlutils.c
Original file line number Diff line number Diff line change
Expand Up @@ -886,10 +886,9 @@ try_read_string (gnutls_session_t *session, int timeout,
*
* @param[in] socket Socket to read from.
* @param[in] timeout Server idle time before giving up, in seconds. 0
* to wait forever.
* @param[out] entity Pointer to an entity tree.
* to wait forever.
* @param[out] string_return An optional return location for the text read
* from the session. If NULL then it simply
* from the socket. If NULL then it simply
* remains NULL. If a pointer to NULL then it
* points to a freshly allocated GString on successful return. Otherwise it
* points to an existing GString onto which the text is appended.
Expand Down Expand Up @@ -1841,8 +1840,6 @@ xml_count_entities (entities_t entities)
* @param[in] xml XML string.
* @param[in] format Format string.
* @param[in] ... Arguments for format string.
*
* @return Result of XSL transformation.
*/
void
xml_string_append (GString *xml, const char *format, ...)
Expand Down

0 comments on commit b773032

Please sign in to comment.