diff --git a/Doxyfile b/Doxyfile index 86bb412..cef4805 100644 --- a/Doxyfile +++ b/Doxyfile @@ -7,7 +7,7 @@ EXTRACT_ALL = YES EXTRACT_PRIVATE = YES # Important: Here the .h files are not listed. Otherwise we get duplications. -FILE_PATTERNS = *.dox *.cpp +FILE_PATTERNS = *.dox *.cpp *.md # This is important for multiline comments (beginning with "///", for example). JAVADOC_AUTOBRIEF = YES @@ -15,3 +15,5 @@ JAVADOC_AUTOBRIEF = YES # We put the generated output in docs/. Note that html/ in the root folder is used for something different. HTML_OUTPUT = docs/html LATEX_OUTPUT = docs/latex + +IMAGE_PATH = . diff --git a/Makefile b/Makefile index 6ae1797..bf4d6a2 100644 --- a/Makefile +++ b/Makefile @@ -54,7 +54,7 @@ BUILD_DIR ?= ./wasm-build SRCS := book.cpp books.cpp cli.cpp fingerprint.cpp main.cpp psalmsinfo.cpp OBJS := $(SRCS:%=$(BUILD_DIR)/%.o) -DOXS := book.dox books.dox cli.dox fingerprint.dox psalmsinfo.dox +DOXS := book.dox books.dox cli.dox fingerprint.dox main.dox psalmsinfo.dox CPPFLAGS += -I/usr/include/sword -s USE_BOOST_HEADERS=1 @@ -86,7 +86,7 @@ documentation: docs/latex/refman.pdf docs/html/index.html docs/latex/refman.pdf: docs/latex/refman.tex $(MAKE) -C docs/latex -docs/html/index.html docs/latex/refman.tex: Doxyfile $(SRCS) $(DOXS) logo-Psalm40-doxygen.png +docs/html/index.html docs/latex/refman.tex: Doxyfile $(SRCS) $(DOXS) README.md logo-Psalm40-doxygen.png doxygen Doxyfile .PHONY: clean documentation diff --git a/main.dox b/main.dox new file mode 100644 index 0000000..75c9048 --- /dev/null +++ b/main.dox @@ -0,0 +1,31 @@ +/** + * @mainpage + * BibRef, a project dedicated to find citations of the + * Septuagint in the Greek New Testament. + * + * This code is in the public domain + * and contributed by Zoltán Kovács . + */ + +/** + * @file main.cpp + * The main program. + */ + +/// Parse the command line input. +/// @author Iain Hull (https://stackoverflow.com/a/868894/1044586) +class InputParser { +public: + /// Parse the command line input. + InputParser(int &argc, char **argv); + /// Get the command option. + const string &getCmdOption(const string &option) const; + /// Is a specific command line option given? + bool cmdOptionExists(const string &option) const; +}; + +/// Show the command line help. +void showHelp(const string &executable); + +/// The main program. +int main(int argc, char **argv);