Added cppcheck and doxygen build targets

CMakeLists.txt

@@ -61,9 +61,24 @@ add_custom_target (checkConfig echo "Checking cppcheck config..."
 
 #################################################################
 
-#docLocal:
-#	sed -i '' 's/HAVE_DOT               = YES/HAVE_DOT               = NO/g' Doxyfile
-#	doxygen
-#	cp -R doc/html/* ../apache/
-#	rm -rf doc
-#	sed -i '' 's/HAVE_DOT               = NO/HAVE_DOT               = YES/g' Doxyfile
+# Generate Doxygen Documentation
+find_package (Doxygen)
+if (DOXYGEN_FOUND)
+    # Configure the Template Doxyfile for our specific project
+    configure_file(Doxyfile.in 
+        ${PROJECT_BINARY_DIR}/Doxyfile  @ONLY IMMEDIATE)
+    # Add a custom target to run Doxygen when ever the project is built
+    add_custom_target (doc
+  	    COMMAND ${DOXYGEN_EXECUTABLE} ${PROJECT_BINARY_DIR}/Doxyfile
+  		SOURCES ${PROJECT_BINARY_DIR}/Doxyfile)
+    # Add custom target to create local documentation without graphs
+    add_custom_target (docLocal
+        COMMAND sed -i '' "s/HAVE_DOT               = YES/HAVE_DOT               = NO/g" Doxyfile
+        COMMAND ${DOXYGEN_EXECUTABLE} ${PROJECT_BINARY_DIR}/Doxyfile
+        COMMAND cp -R doc/html/* ${PROJECT_SOURCE_DIR}/../apache/
+        COMMAND sed -i '' "s/HAVE_DOT               = NO/HAVE_DOT               = YES/g" Doxyfile
+        SOURCES ${PROJECT_BINARY_DIR}/Doxyfile)
+endif(DOXYGEN_FOUND)
+
+# Clean doc files
+set_directory_properties(PROPERTIES ADDITIONAL_MAKE_CLEAN_FILES "doc")

Doxyfile → Doxyfile.in

@@ -38,7 +38,7 @@ PROJECT_NAME           = OpenRaider
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 0.1.2-dev
+PROJECT_NUMBER         = @OpenRaider_VERSION_MAJOR@.@OpenRaider_VERSION_MINOR@.@OpenRaider_VERSION_MICRO@-dev
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a
@@ -58,7 +58,7 @@ PROJECT_LOGO           =
 # entered, it will be relative to the location where doxygen was started. If
 # left blank the current directory will be used.
 
-OUTPUT_DIRECTORY       = doc
+OUTPUT_DIRECTORY       = @PROJECT_BINARY_DIR@/doc
 
 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
 # directories (in 2 levels) under the output directory of each output format and
@@ -142,7 +142,7 @@ FULL_PATH_NAMES        = YES
 # will be relative from the directory where doxygen is started.
 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
 
-STRIP_FROM_PATH        = 
+STRIP_FROM_PATH        = @PROJECT_SOURCE_DIR@
 
 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
 # path mentioned in the documentation of a class, which tells the reader which
@@ -733,7 +733,7 @@ WARN_LOGFILE           =
 # spaces.
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = 
+INPUT                  = @PROJECT_SOURCE_DIR@/include @PROJECT_SOURCE_DIR@/src @PROJECT_SOURCE_DIR@/test
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -2223,7 +2223,7 @@ INTERACTIVE_SVG        = YES
 # found. If left blank, it is assumed the dot tool can be found in the path.
 # This tag requires that the tag HAVE_DOT is set to YES.
 
-DOT_PATH               = 
+DOT_PATH               = @DOXYGEN_DOT_PATH@
 
 # The DOTFILE_DIRS tag can be used to specify one or more directories that
 # contain dot files that are included in the documentation (see the \dotfile

README.md

@@ -67,7 +67,11 @@ Do a standard cmake build and then run the resulting executable:
 
 On Mac OS X, running `make install` will produce a distributable OpenRaider.app bundle.
 
-To build all Unit Tests, run `make tests`, to run most of them use `make testRun`. To run a TombRaider level loader regression test, use `make testReg`. The results will be put into log files in your build folder. `make clean` will remove them.
+To build all Unit Tests, run `make tests`, to run most of them use `make testRun`.
+To run a TombRaider level loader regression test, use `make testReg`. The results will be put into log files in your build folder.
+You can run a static analysis with cppcheck using `make check`, `make checkFull` or `make checkConfig`.
+A Doxygen API documentation can be created with `make doc`. `make docLocal` will not create additional graphs for the documentation and tries to copy the result into a directory called apache on the parent level of the OpenRaider project directory.
+`make clean` should remove all intermediary files.
 
 ## Usage