First attempts with doxygen

Doxyfile

@@ -0,0 +1,10 @@
+PROJECT_NAME = bibref
+PROJECT_NUMBER = 2023-12-17
+PROJECT_BRIEF = A tool to find internal references in the Bible
+PROJECT_LOGO = logo-Psalm40-doxygen.png
+
+EXTRACT_ALL = YES
+EXTRACT_PRIVATE = YES
+
+HTML_OUTPUT = docs/html
+LATEX_OUTPUT = docs/latex

Makefile

@@ -80,6 +80,14 @@ $(BUILD_DIR)/%.cpp.o: %.cpp
 	$(MKDIR_P) $(dir $@)
 	$(CXX) $(CPPFLAGS) $(CXXFLAGS) -c $< -o $@
 
+documentation: docs/latex/refman.pdf docs/html
+
+docs/latex/refman.pdf: docs/latex
+	$(MAKE) -C docs/latex
+
+docs/html docs/latex: Doxyfile $(SRCS) logo-Psalm40-doxygen.png
+	doxygen Doxyfile
+
 .PHONY: clean
 
 clean:

cli.dox

@@ -0,0 +1,40 @@
+/**
+ * @file cli.h
+ * Command line interface (CLI) related code.
+ */
+
+void cli(const char *input_prepend, const char* output_prepend, bool addbooks, bool colored) {
+ /**
+  * @short Start the CLI.
+  * Start the command line interface.
+  * @param input_prepend Prepend a string before all input lines.
+  * @param output_prepend Prepend a string before all output lines.
+  * @param addbooks Load book databases immediately on startup.
+  * @param colored Show all texts colored if possible.
+  */
+}
+
+void add_vocabulary_item(string item) {
+ /**
+  * @short Adds item to the vocabulary.
+  * Extend the vocabulary with an extra word.
+  * It can be recalled by the usual readline shortcuts.
+  * @param item Add this item to the vocabulary.
+  */
+}
+
+void error(string message) {
+ /**
+  * @short Print an error.
+  * Print an error message to standard error.
+  * @param message The message to print.
+  */
+}
+
+void info(string message) {
+ /**
+  * @short Print an info.
+  * Prints an info message to standard out.
+  * @param message The message to print.
+  */
+}

cli.h

@@ -5,7 +5,6 @@
 
 using namespace std;
 
-char** completer(const char* text, int start, int end);
 void cli(const char *input_prepend, const char* output_prepend, bool addbooks, bool colored);
 void add_vocabulary_item(string item);
 void error(string message);