Documentation

FossilOrigin-Name: 9398cc0f07d10a8ba30ad54092613a14b816c19c9d4cb5d424a98802cc52703f

include/mastodont.h

@@ -28,14 +28,38 @@
 #include <mastodont_announcement.h>
 #include <mastodont_static.h>
 
-/* Functions required form curl */
+//! Initializes libcurl
 void mastodont_global_curl_init();
+//! Cleans up libcurl
 void mastodont_global_curl_cleanup();
 
+/*!
+ * Initializes a mastodont struct
+ *
+ * \param data Pointer to struct to fill in
+ * \return Value of curl_easy_init(); either Zero or non-zero
+ */
 int mastodont_init(mastodont_t* data);
+
+/*!
+ * Cleans up the mastodont struct
+ *
+ * \param data Pointer to the mastodont data
+ */
 void mastodont_cleanup(mastodont_t* data);
+
+/*!
+ * Call's free() or a library derivative
+ */
 void mastodont_free(void*);
 
+/*!
+ * Cleans up a storage struct.
+ *
+ * This contains information such as JSON information and errors.
+ *
+ * \param storage The storage block to cleanup
+ */
 void mastodont_storage_cleanup(struct mstdnt_storage* storage);
 
 #endif /* MASTODONT_H */

include/mastodont_codes.h

@@ -0,0 +1,26 @@
+/*
+ * This program is free software: you can redistribute it and/or modify it under
+ * the terms of the GNU Lesser General Public License as published by the Free
+ * Software Foundation, either version 3 of the License, or (at your option) any
+ * later version.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+
+#ifndef MASTODONT_CODES_H
+#define MASTODONT_CODES_H
+
+enum mstdnt_code
+{
+    MSTDNT_SUCCESS = 0,
+    MSTDNT_ERROR = 1,
+    MSTNDT_LIBCURL,
+};
+
+#endif /* MASTODONT_CODES_H */