From 5a754bcdc0f5e432c1d7cd358c74dfb2d6f0f1ea Mon Sep 17 00:00:00 2001
From: Joseph Hunkeler <jhunkeler@gmail.com>
Date: Sat, 28 Dec 2019 12:28:25 -0500
Subject: Fixes:

* doxygen config
* doxygen @file directives
* corrected stupid strip() implemention
* corrected strip usage by config parser. wrong pointer.
---
 src/mime.c | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

(limited to 'src/mime.c')

diff --git a/src/mime.c b/src/mime.c
index d90cc3f..9fcf97b 100644
--- a/src/mime.c
+++ b/src/mime.c
@@ -1,5 +1,13 @@
+/**
+ * @file mime.c
+ */
 #include "spm.h"
 
+/**
+ * Execute OS `file` command
+ * @param _filename path to file
+ * @return Process structure
+ */
 Process *file_command(const char *_filename) {
     char *filename = strdup(_filename);
     Process *proc_info = NULL;
@@ -26,6 +34,11 @@ Process *file_command(const char *_filename) {
     return proc_info;
 }
 
+/**
+ * Execute the `file` command, parse its output, and return the data in a `Mime` structure
+ * @param filename path to file
+ * @return Mime structure
+ */
 Mime *file_mimetype(const char *filename) {
     char **output = NULL;
     char **parts = NULL;
@@ -63,6 +76,10 @@ Mime *file_mimetype(const char *filename) {
     return type;
 }
 
+/**
+ * Free a `Mime` structure
+ * @param m
+ */
 void mime_free(Mime *m) {
     if (m != NULL) {
         free(m->origin);
@@ -72,6 +89,11 @@ void mime_free(Mime *m) {
     }
 }
 
+/**
+ * Determine if a file is a text file
+ * @param filename
+ * @return yes=1, no=0
+ */
 int file_is_text(const char *filename) {
     int result = 0;
     char *path = normpath(filename);
@@ -84,6 +106,11 @@ int file_is_text(const char *filename) {
     return result;
 }
 
+/**
+ * Determine if a file is a binary data file
+ * @param filename
+ * @return yes=1, no=0
+ */
 int file_is_binary(const char *filename) {
     int result = 0;
     char *path = normpath(filename);
-- 
cgit