Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clear doxygen warnings #803

Merged
merged 2 commits into from
Jan 8, 2024
Merged

Clear doxygen warnings #803

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b773032
Clear doxy warnings
mattmundell Dec 19, 2023
cff0d3e
Spread doxy comments
mattmundell Dec 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions base/hosts.c
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
Loading
Loading