Merge pull request #803 from mattmundell/code-doc

Clear doxygen warnings

base/hosts.c

@@ -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.
  *
@@ -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.
  *
@@ -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

base/nvti.c

@@ -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.
  */
@@ -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.
  */
@@ -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.
  */
@@ -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.
  */
@@ -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.
  */

gmp/gmp.c

@@ -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.

osp/osp.c

@@ -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.
@@ -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.
  */
@@ -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
@@ -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.
  */