aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoseph Hunkeler <jhunkeler@gmail.com>2019-12-06 15:08:18 -0500
committerJoseph Hunkeler <jhunkeler@gmail.com>2019-12-06 15:08:18 -0500
commit1f8380814aff5429d3c1d27a3b9b82aa6102b764 (patch)
treefc4691a80630acd0812745b8735cf8df2bfa1ef7
parentc81894a758b98006802e2e006e75a91076811d86 (diff)
downloadspmc-1f8380814aff5429d3c1d27a3b9b82aa6102b764.tar.gz
More documentation
-rw-r--r--.gitignore1
-rw-r--r--config.c4
-rw-r--r--doxygen.conf6
-rw-r--r--spm.c2
-rw-r--r--spm.h5
5 files changed, 7 insertions, 11 deletions
diff --git a/.gitignore b/.gitignore
index af613f1..bd50c2e 100644
--- a/.gitignore
+++ b/.gitignore
@@ -10,4 +10,5 @@ compile_commands.json
CTestTestfile.cmake
cmake-build-debug
build
+docs
pkgs
diff --git a/config.c b/config.c
index c2d905b..c07c16a 100644
--- a/config.c
+++ b/config.c
@@ -1,10 +1,12 @@
+/**
+ * @file config.c
+ */
#include <ctype.h>
#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include "spm.h"
-
/// Remove leading whitespace from a string
/// \param sptr pointer to string
/// \return pointer to first non-whitespace character in string
diff --git a/doxygen.conf b/doxygen.conf
index e535d50..2c0914d 100644
--- a/doxygen.conf
+++ b/doxygen.conf
@@ -8,7 +8,7 @@ PROJECT_NAME = "Simple Package Manager"
PROJECT_NUMBER = ${VERSION}
PROJECT_BRIEF = "a.k.a. SPM"
PROJECT_LOGO =
-OUTPUT_DIRECTORY = /home/jhunk/CLionProjects/spm/docs
+OUTPUT_DIRECTORY = ./docs
CREATE_SUBDIRS = NO
ALLOW_UNICODE_NAMES = NO
OUTPUT_LANGUAGE = English
@@ -198,7 +198,7 @@ IGNORE_PREFIX =
#---------------------------------------------------------------------------
# Configuration options related to the HTML output
#---------------------------------------------------------------------------
-GENERATE_HTML = NO
+GENERATE_HTML = YES
HTML_OUTPUT = html
HTML_FILE_EXTENSION = .html
HTML_HEADER =
@@ -376,4 +376,4 @@ MAX_DOT_GRAPH_DEPTH = 0
DOT_TRANSPARENT = NO
DOT_MULTI_TARGETS = NO
GENERATE_LEGEND = YES
-DOT_CLEANUP = YES \ No newline at end of file
+DOT_CLEANUP = YES
diff --git a/spm.c b/spm.c
index a20fecd..4fb9ed8 100644
--- a/spm.c
+++ b/spm.c
@@ -16,8 +16,6 @@
#include "config.h"
#include "spm.h"
-
-
/**
* A wrapper for `popen()` that executes non-interactive programs and reports their exit value.
* To redirect stdout and stderr you must do so from within the `fmt` string
diff --git a/spm.h b/spm.h
index 8822db1..4b033d0 100644
--- a/spm.h
+++ b/spm.h
@@ -44,8 +44,6 @@ char *substring_between(char *sptr, const char *delims);
int has_rpath(const char *filename);
char *get_rpath(const char *filename);
-
-
// config.c
#define CONFIG_BUFFER_SIZE 1024
@@ -62,7 +60,4 @@ Config **config_read(const char *filename);
void config_free(Config **config);
void config_test(void);
-
-
-
#endif //SPM_SPM_H