Doc: add docstring

openvasd/jsonutils.c

@@ -16,6 +16,9 @@
 #include <stdlib.h>
 #include <unistd.h>
 
+/**
+ * @brief VT categories
+ */
 typedef enum
 {
   ACT_INIT = 0,
@@ -31,6 +34,13 @@ typedef enum
   ACT_END,
 } nvt_category;
 
+/**
+ * @brief Get the VT category type given the category as string
+ *
+ * @param cat The category as string.
+ *
+ * @return Integer representing the category type.
+ */
 static int
 get_category_from_name (const char *cat)
 {
@@ -60,6 +70,10 @@ get_category_from_name (const char *cat)
   return -1;
 }
 
+/**
+ * @brief Get a new json parser object. It must be free with
+ *        gvm_close_jnode_parser() by the caller.
+ */
 jparser_t
 gvm_parse_jnode (void)
 {
@@ -68,23 +82,39 @@ gvm_parse_jnode (void)
   return parser;
 }
 
+/**
+ * @brief Create a JSON reader object
+ *
+ * @param[in] str JSON data as string to be read.
+ * @param[in] parse The JSON parser to be use for loading the JSON data.
+ * @param[out] read The JSON reader pointing to the begining of the data
+ *
+ * @return 0 on sucess, -1 otherwise. It must be free with
+ *        gvm_close_jnode_parser() by the caller.
+ */
 int
-gvm_read_jnode (const char *str, jparser_t parse, jreader_t *reade)
+gvm_read_jnode (const char *str, jparser_t parse, jreader_t *read)
 {
   JsonParser *parser = parse;
 
   GError *err = NULL;
   if (!json_parser_load_from_data (parser, str, strlen (str), &err))
     {
-      g_warning ("%s: Parsing json string", __func__);
+      g_warning ("%s: Parsing json string: %s", __func__, err->message);
+      g_error_free (err);
       g_object_unref (parser);
       return -1;
     }
 
-  *reade = (jreader_t) json_reader_new (json_parser_get_root (parser));
+  *read = (jreader_t) json_reader_new (json_parser_get_root (parser));
   return 0;
 }
 
+/**
+ * @brief Free JSON reader object
+ *
+ * @param read JSON Reader to be free()'d.
+ */
 void
 gvm_close_jnode_reader (jreader_t read)
 {
@@ -93,6 +123,11 @@ gvm_close_jnode_reader (jreader_t read)
     g_object_unref (reader);
 }
 
+/**
+ * @brief Free JSON parser object
+ *
+ * @param parse JSON parser to be free()'d.
+ */
 void
 gvm_close_jnode_parser (jparser_t parse)
 {
@@ -102,6 +137,13 @@ gvm_close_jnode_parser (jparser_t parse)
     g_object_unref (parser);
 }
 
+/**
+ * @brief Count the elements in an array.
+ *
+ * @param[in] read JSON reader object pointing to an array.
+ *
+ * @return Integer with the amount of elements in the array, -1 otherwise.
+ */
 int
 gvm_jnode_count_elements (jreader_t read)
 {
@@ -116,6 +158,14 @@ gvm_jnode_count_elements (jreader_t read)
   return json_reader_count_elements (reader);
 }
 
+/**
+ * @brief Parse a VT element given in json format.
+ *
+ * @param[in] reader JSON reader object pointing to an VT element.
+ *
+ * @return nvti structur containing the VT metadata, NULL otherwise.
+ *              The nvti struct must be free() by the caller
+ */
 nvti_t *
 gvm_jnode_parse_vt (jreader_t reader)
 {

openvasd/openvasd.c

@@ -27,16 +27,19 @@
 
 #define RESP_CODE_ERR -1
 
+/**
+ * @brief Struct holding the data for connecting with Openvasd.
+ */
 struct openvasd_connector
 {
-  char *ca_cert; // Path to the directory holding the CA certificate
-  char *cert;    // Client certificate
-  char *key;     // Client key
-  char *apikey;  // API key for authentication
-  char *server;  // original openvasd server URL
-  char *host;    // server hostname
-  char *scan_id; // Scan ID
-  int port;      // server port
+  char *ca_cert; /**< Path to the directory holding the CA certificate. */
+  char *cert;    /**< Client certificate. */
+  char *key;     /**< Client key. */
+  char *apikey;  /**< API key for authentication. */
+  char *server;  /**< original openvasd server URL. */
+  char *host;    /**< server hostname. */
+  char *scan_id; /**< Scan ID. */
+  int port;      /**< server port. */
 };
 
 /**
@@ -92,6 +95,9 @@ struct openvasd_vt_single
   GHashTable *vt_values;
 };
 
+/**
+ * @brief Request methods
+ */
 enum openvas_request_method
 {
   POST,
@@ -203,6 +209,11 @@ openvasd_connector_free (openvasd_connector_t *conn)
   return OPENVASD_OK;
 }
 
+/**
+ * @brief Free an openvasd response struct
+ *
+ * @param resp Response to be free()'d
+ */
 void
 openvasd_response_free (openvasd_resp_t resp)
 {
@@ -459,12 +470,27 @@ openvasd_send_request (openvasd_connector_t *conn, openvasd_req_method_t method,
   return response;
 }
 
+/**
+ * @brief Request HEAD
+ *
+ * @param conn Connector struct with the data necessary for the connection
+ *
+ * @return Response containing the header information
+ */
 openvasd_resp_t
 openvasd_get_version (openvasd_connector_t *conn)
 {
   return openvasd_send_request (conn, HEAD, "/", NULL, NULL);
 }
 
+/**
+ * @brief Get VT's metadata
+ *
+ * @param conn Connector struct with the data necessary for the connection
+ *
+ * @return Response Struct containing the feed metadata in json format in the
+ * body. NULL on error.
+ */
 openvasd_resp_t
 openvasd_get_vts (openvasd_connector_t *conn)
 {
@@ -484,6 +510,14 @@ openvasd_get_vts (openvasd_connector_t *conn)
   return response;
 }
 
+/**
+ * @brief Get VT's metadata
+ *
+ * @param conn Connector struct with the data necessary for the connection
+ *
+ * @return Response Struct containing the feed metadata in json format in the
+ * body. NULL on error.
+ */
 openvasd_resp_t
 openvasd_start_scan (openvasd_connector_t *conn, char *data)
 {