Documentation

10 files changed, 455 insertions, 57 deletions

diff --git a/.doxygen b/.doxygen
new file mode 100644
index 0000000..bd3dc05
--- /dev/null
+++ b/.doxygen
@@ -0,0 +1,374 @@
+# Doxyfile 1.8.13
+
+#---------------------------------------------------------------------------
+# Project related configuration options
+#---------------------------------------------------------------------------
+DOXYFILE_ENCODING      = UTF-8
+PROJECT_NAME           = engine
+PROJECT_NUMBER         =
+PROJECT_BRIEF          =
+PROJECT_LOGO           =
+OUTPUT_DIRECTORY       = ./doc
+CREATE_SUBDIRS         = NO
+ALLOW_UNICODE_NAMES    = NO
+OUTPUT_LANGUAGE        = English
+BRIEF_MEMBER_DESC      = YES
+REPEAT_BRIEF           = YES
+ABBREVIATE_BRIEF       = "The $name class" \
+                         "The $name widget" \
+                         "The $name file" \
+                         is \
+                         provides \
+                         specifies \
+                         contains \
+                         represents \
+                         a \
+                         an \
+                         the
+ALWAYS_DETAILED_SEC    = NO
+INLINE_INHERITED_MEMB  = NO
+FULL_PATH_NAMES        = YES
+STRIP_FROM_PATH        =
+STRIP_FROM_INC_PATH    =
+SHORT_NAMES            = NO
+JAVADOC_AUTOBRIEF      = NO
+QT_AUTOBRIEF           = NO
+MULTILINE_CPP_IS_BRIEF = NO
+INHERIT_DOCS           = YES
+SEPARATE_MEMBER_PAGES  = NO
+TAB_SIZE               = 4
+ALIASES                =
+TCL_SUBST              =
+OPTIMIZE_OUTPUT_FOR_C  = NO
+OPTIMIZE_OUTPUT_JAVA   = NO
+OPTIMIZE_FOR_FORTRAN   = NO
+OPTIMIZE_OUTPUT_VHDL   = NO
+EXTENSION_MAPPING      =
+MARKDOWN_SUPPORT       = YES
+TOC_INCLUDE_HEADINGS   = 0
+AUTOLINK_SUPPORT       = YES
+BUILTIN_STL_SUPPORT    = NO
+CPP_CLI_SUPPORT        = NO
+SIP_SUPPORT            = NO
+IDL_PROPERTY_SUPPORT   = YES
+DISTRIBUTE_GROUP_DOC   = NO
+GROUP_NESTED_COMPOUNDS = NO
+SUBGROUPING            = YES
+INLINE_GROUPED_CLASSES = NO
+INLINE_SIMPLE_STRUCTS  = NO
+TYPEDEF_HIDES_STRUCT   = NO
+LOOKUP_CACHE_SIZE      = 0
+#---------------------------------------------------------------------------
+# Build related configuration options
+#---------------------------------------------------------------------------
+EXTRACT_ALL            = NO
+EXTRACT_PRIVATE        = NO
+EXTRACT_PACKAGE        = NO
+EXTRACT_STATIC         = NO
+EXTRACT_LOCAL_CLASSES  = YES
+EXTRACT_LOCAL_METHODS  = NO
+EXTRACT_ANON_NSPACES   = NO
+HIDE_UNDOC_MEMBERS     = NO
+HIDE_UNDOC_CLASSES     = NO
+HIDE_FRIEND_COMPOUNDS  = NO
+HIDE_IN_BODY_DOCS      = NO
+INTERNAL_DOCS          = NO
+CASE_SENSE_NAMES       = NO
+HIDE_SCOPE_NAMES       = NO
+HIDE_COMPOUND_REFERENCE= NO
+SHOW_INCLUDE_FILES     = YES
+SHOW_GROUPED_MEMB_INC  = NO
+FORCE_LOCAL_INCLUDES   = NO
+INLINE_INFO            = YES
+SORT_MEMBER_DOCS       = YES
+SORT_BRIEF_DOCS        = NO
+SORT_MEMBERS_CTORS_1ST = NO
+SORT_GROUP_NAMES       = NO
+SORT_BY_SCOPE_NAME     = NO
+STRICT_PROTO_MATCHING  = NO
+GENERATE_TODOLIST      = YES
+GENERATE_TESTLIST      = YES
+GENERATE_BUGLIST       = YES
+GENERATE_DEPRECATEDLIST= YES
+ENABLED_SECTIONS       =
+MAX_INITIALIZER_LINES  = 30
+SHOW_USED_FILES        = YES
+SHOW_FILES             = YES
+SHOW_NAMESPACES        = YES
+FILE_VERSION_FILTER    =
+LAYOUT_FILE            =
+CITE_BIB_FILES         =
+#---------------------------------------------------------------------------
+# Configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+QUIET                  = NO
+WARNINGS               = YES
+WARN_IF_UNDOCUMENTED   = YES
+WARN_IF_DOC_ERROR      = YES
+WARN_NO_PARAMDOC       = NO
+WARN_AS_ERROR          = NO
+WARN_FORMAT            = "$file:$line: $text"
+WARN_LOGFILE           =
+#---------------------------------------------------------------------------
+# Configuration options related to the input files
+#---------------------------------------------------------------------------
+INPUT                  = .
+INPUT_ENCODING         = UTF-8
+FILE_PATTERNS          = *.c \
+                         *.cc \
+                         *.cxx \
+                         *.cpp \
+                         *.c++ \
+                         *.java \
+                         *.ii \
+                         *.ixx \
+                         *.ipp \
+                         *.i++ \
+                         *.inl \
+                         *.idl \
+                         *.ddl \
+                         *.odl \
+                         *.h \
+                         *.hh \
+                         *.hxx \
+                         *.hpp \
+                         *.h++ \
+                         *.cs \
+                         *.d \
+                         *.php \
+                         *.php4 \
+                         *.php5 \
+                         *.phtml \
+                         *.inc \
+                         *.m \
+                         *.markdown \
+                         *.md \
+                         *.mm \
+                         *.dox \
+                         *.py \
+                         *.pyw \
+                         *.f90 \
+                         *.f95 \
+                         *.f03 \
+                         *.f08 \
+                         *.f \
+                         *.for \
+                         *.tcl \
+                         *.vhd \
+                         *.vhdl \
+                         *.ucf \
+                         *.qsf
+RECURSIVE              = NO
+EXCLUDE                =
+EXCLUDE_SYMLINKS       = NO
+EXCLUDE_PATTERNS       =
+EXCLUDE_SYMBOLS        =
+EXAMPLE_PATH           =
+EXAMPLE_PATTERNS       = *
+EXAMPLE_RECURSIVE      = NO
+IMAGE_PATH             =
+INPUT_FILTER           =
+FILTER_PATTERNS        =
+FILTER_SOURCE_FILES    = NO
+FILTER_SOURCE_PATTERNS =
+USE_MDFILE_AS_MAINPAGE =
+#---------------------------------------------------------------------------
+# Configuration options related to source browsing
+#---------------------------------------------------------------------------
+SOURCE_BROWSER         = NO
+INLINE_SOURCES         = NO
+STRIP_CODE_COMMENTS    = YES
+REFERENCED_BY_RELATION = NO
+REFERENCES_RELATION    = NO
+REFERENCES_LINK_SOURCE = YES
+SOURCE_TOOLTIPS        = YES
+USE_HTAGS              = NO
+VERBATIM_HEADERS       = YES
+CLANG_ASSISTED_PARSING = NO
+CLANG_OPTIONS          =
+#---------------------------------------------------------------------------
+# Configuration options related to the alphabetical class index
+#---------------------------------------------------------------------------
+ALPHABETICAL_INDEX     = YES
+COLS_IN_ALPHA_INDEX    = 5
+IGNORE_PREFIX          =
+#---------------------------------------------------------------------------
+# Configuration options related to the HTML output
+#---------------------------------------------------------------------------
+GENERATE_HTML          = YES
+HTML_OUTPUT            = html
+HTML_FILE_EXTENSION    = .html
+HTML_HEADER            =
+HTML_FOOTER            =
+HTML_STYLESHEET        =
+HTML_EXTRA_STYLESHEET  =
+HTML_EXTRA_FILES       =
+HTML_COLORSTYLE_HUE    = 220
+HTML_COLORSTYLE_SAT    = 100
+HTML_COLORSTYLE_GAMMA  = 80
+HTML_TIMESTAMP         = NO
+HTML_DYNAMIC_SECTIONS  = NO
+HTML_INDEX_NUM_ENTRIES = 100
+GENERATE_DOCSET        = NO
+DOCSET_FEEDNAME        = "Doxygen generated docs"
+DOCSET_BUNDLE_ID       = org.doxygen.Project
+DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
+DOCSET_PUBLISHER_NAME  = Publisher
+GENERATE_HTMLHELP      = NO
+CHM_FILE               =
+HHC_LOCATION           =
+GENERATE_CHI           = NO
+CHM_INDEX_ENCODING     =
+BINARY_TOC             = NO
+TOC_EXPAND             = NO
+GENERATE_QHP           = NO
+QCH_FILE               =
+QHP_NAMESPACE          = org.doxygen.Project
+QHP_VIRTUAL_FOLDER     = doc
+QHP_CUST_FILTER_NAME   =
+QHP_CUST_FILTER_ATTRS  =
+QHP_SECT_FILTER_ATTRS  =
+QHG_LOCATION           =
+GENERATE_ECLIPSEHELP   = NO
+ECLIPSE_DOC_ID         = org.doxygen.Project
+DISABLE_INDEX          = NO
+GENERATE_TREEVIEW      = YES
+ENUM_VALUES_PER_LINE   = 4
+TREEVIEW_WIDTH         = 250
+EXT_LINKS_IN_WINDOW    = NO
+FORMULA_FONTSIZE       = 10
+FORMULA_TRANSPARENT    = YES
+USE_MATHJAX            = NO
+MATHJAX_FORMAT         = HTML-CSS
+MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
+MATHJAX_EXTENSIONS     =
+MATHJAX_CODEFILE       =
+SEARCHENGINE           = YES
+SERVER_BASED_SEARCH    = NO
+EXTERNAL_SEARCH        = NO
+SEARCHENGINE_URL       =
+SEARCHDATA_FILE        = searchdata.xml
+EXTERNAL_SEARCH_ID     =
+EXTRA_SEARCH_MAPPINGS  =
+#---------------------------------------------------------------------------
+# Configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+GENERATE_LATEX         = NO
+LATEX_OUTPUT           = latex
+LATEX_CMD_NAME         = latex
+MAKEINDEX_CMD_NAME     = makeindex
+COMPACT_LATEX          = NO
+PAPER_TYPE             = a4
+EXTRA_PACKAGES         =
+LATEX_HEADER           =
+LATEX_FOOTER           =
+LATEX_EXTRA_STYLESHEET =
+LATEX_EXTRA_FILES      =
+PDF_HYPERLINKS         = YES
+USE_PDFLATEX           = YES
+LATEX_BATCHMODE        = NO
+LATEX_HIDE_INDICES     = NO
+LATEX_SOURCE_CODE      = NO
+LATEX_BIB_STYLE        = plain
+LATEX_TIMESTAMP        = NO
+#---------------------------------------------------------------------------
+# Configuration options related to the RTF output
+#---------------------------------------------------------------------------
+GENERATE_RTF           = NO
+RTF_OUTPUT             = rtf
+COMPACT_RTF            = NO
+RTF_HYPERLINKS         = NO
+RTF_STYLESHEET_FILE    =
+RTF_EXTENSIONS_FILE    =
+RTF_SOURCE_CODE        = NO
+#---------------------------------------------------------------------------
+# Configuration options related to the man page output
+#---------------------------------------------------------------------------
+GENERATE_MAN           = NO
+MAN_OUTPUT             = man
+MAN_EXTENSION          = .3
+MAN_SUBDIR             =
+MAN_LINKS              = NO
+#---------------------------------------------------------------------------
+# Configuration options related to the XML output
+#---------------------------------------------------------------------------
+GENERATE_XML           = NO
+XML_OUTPUT             = xml
+XML_PROGRAMLISTING     = YES
+#---------------------------------------------------------------------------
+# Configuration options related to the DOCBOOK output
+#---------------------------------------------------------------------------
+GENERATE_DOCBOOK       = NO
+DOCBOOK_OUTPUT         = docbook
+DOCBOOK_PROGRAMLISTING = NO
+#---------------------------------------------------------------------------
+# Configuration options for the AutoGen Definitions output
+#---------------------------------------------------------------------------
+GENERATE_AUTOGEN_DEF   = NO
+#---------------------------------------------------------------------------
+# Configuration options related to the Perl module output
+#---------------------------------------------------------------------------
+GENERATE_PERLMOD       = NO
+PERLMOD_LATEX          = NO
+PERLMOD_PRETTY         = YES
+PERLMOD_MAKEVAR_PREFIX =
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor
+#---------------------------------------------------------------------------
+ENABLE_PREPROCESSING   = YES
+MACRO_EXPANSION        = NO
+EXPAND_ONLY_PREDEF     = NO
+SEARCH_INCLUDES        = YES
+INCLUDE_PATH           =
+INCLUDE_FILE_PATTERNS  =
+PREDEFINED             =
+EXPAND_AS_DEFINED      =
+SKIP_FUNCTION_MACROS   = YES
+#---------------------------------------------------------------------------
+# Configuration options related to external references
+#---------------------------------------------------------------------------
+TAGFILES               =
+GENERATE_TAGFILE       =
+ALLEXTERNALS           = NO
+EXTERNAL_GROUPS        = YES
+EXTERNAL_PAGES         = YES
+PERL_PATH              = /usr/bin/perl
+#---------------------------------------------------------------------------
+# Configuration options related to the dot tool
+#---------------------------------------------------------------------------
+CLASS_DIAGRAMS         = NO
+MSCGEN_PATH            =
+DIA_PATH               =
+HIDE_UNDOC_RELATIONS   = YES
+HAVE_DOT               = YES
+DOT_NUM_THREADS        = 0
+DOT_FONTNAME           = Helvetica
+DOT_FONTSIZE           = 10
+DOT_FONTPATH           =
+CLASS_GRAPH            = YES
+COLLABORATION_GRAPH    = YES
+GROUP_GRAPHS           = YES
+UML_LOOK               = NO
+UML_LIMIT_NUM_FIELDS   = 10
+TEMPLATE_RELATIONS     = NO
+INCLUDE_GRAPH          = YES
+INCLUDED_BY_GRAPH      = YES
+CALL_GRAPH             = YES
+CALLER_GRAPH           = YES
+GRAPHICAL_HIERARCHY    = YES
+DIRECTORY_GRAPH        = YES
+DOT_IMAGE_FORMAT       = png
+INTERACTIVE_SVG        = NO
+DOT_PATH               =
+DOTFILE_DIRS           =
+MSCFILE_DIRS           =
+DIAFILE_DIRS           =
+PLANTUML_JAR_PATH      =
+PLANTUML_CFG_FILE      =
+PLANTUML_INCLUDE_PATH  =
+DOT_GRAPH_MAX_NODES    = 50
+MAX_DOT_GRAPH_DEPTH    = 0
+DOT_TRANSPARENT        = NO
+DOT_MULTI_TARGETS      = NO
+GENERATE_LEGEND        = YES
+DOT_CLEANUP            = YES
diff --git a/.gitignore b/.gitignore
index d1b97a1..79beff7 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,4 +1,5 @@
 *.o
 build/*
 bin/*
+doc/*
 version.h
diff --git a/Makefile b/Makefile
index 649aad5..ddc4dca 100644
--- a/Makefile
+++ b/Makefile
@@ -35,7 +35,7 @@ all: clean build
 
 clean:
 	rm -df  $(OBJ) test.o version.h
-	rm -Rdf $(BUILDDIR)/lib $(BUILDDIR)/inc $(BUILDDIR)/test
+	rm -Rdf $(BUILDDIR)/lib $(BUILDDIR)/inc $(BUILDDIR)/test doc/
 
 run: test
 	./$(BUILDDIR)/test/test
@@ -54,3 +54,7 @@ test: genversion test.o $(OBJ)
 	mkdir -p $(BUILDDIR)/test
 	$(CC) $(DEBUGFLAGS) -o $(BUILDDIR)/test/test test.o $(OBJ) $(LDFLAGS)
 	./$(BUILDDIR)/test/test test
+
+doc:
+	mkdir -p doc
+	doxygen .doxygen
diff --git a/Readme.md b/Readme.md
index e94db7f..80eb513 100644
--- a/Readme.md
+++ b/Readme.md
@@ -1,6 +1,6 @@
 [![Build Status](https://travis-ci.org/kompetenzbolzen/engine.svg?branch=master)](https://travis-ci.org/kompetenzbolzen/engine)
 
-# Compiling
+## Compiling
 
 engine should compile just fine with just the c++ standard librarys.
 Required Packages:
@@ -10,8 +10,8 @@ Required Packages:
 
 this creates two folders in ./build/: lib and inc, wich hold the library and the headers respectively. these can then be copied into your projects directory.
 
-# Using
+## Using
 
 Compile your program with linkerflags:
 
-    -L./lib -lengine -lstdc++
+    -L/path/to/lib -lengine -lstdc++
diff --git a/cInput.h b/cInput.h
index 49d13b7..529aa81 100644
--- a/cInput.h
+++ b/cInput.h
@@ -32,7 +32,12 @@ struct sInputEvent
   unsigned int b;
   int x, y;
 };
-
+/**
+* ##cInput
+* * puts STDIN in raw mode
+* * activates mouse tracking
+* * reverts console back to normal operation on destruction.
+*/
 class cInput
 {
 public:
@@ -42,7 +47,12 @@ public:
 
   /** Reads inputevents
   * returns event struct
-  * event queu is empty, when sInputEvent.type == _EVENT_NULL
+  * ### sInputEvent.type
+  * * _EVENT_NULL: No input recorded
+  * * _EVENT_CHAR: A Key was pressed, stored in .c
+  * * _EVENT_KEY: Escape sequence recorded, stored in .c without escape char
+  * * _EVENT_MOUSE: Console registered click at (.x, .y) with origin at (0,0) (top left). Mouse button stored in b.
+  * * _EVENT_TERM: Console registered Ctrl+C
   */
   sInputEvent poll();
 
diff --git a/cObject.h b/cObject.h
index 87d0205..d0947da 100644
--- a/cObject.h
+++ b/cObject.h
@@ -12,14 +12,26 @@ struct sObject
 	int sizeX;
 	int sizeY;
 };
-/* cObject can be used standalone as well as inherited
+
+/** cObject can be used standalone as well as inherited
 * every cObject has its own framebuffer as well as position viariables to be moveable.
-* cObject is used by cObjectHandler to manage all objects to be displayed
+* cObject is used by cObjectHandler to manage all objects to be displayed.
+*
+* Minimal example for inheriting class
+*
+*
+*			class example : cObject
+*			{
+*			public:
+*				example() { setSize(10,5); }
+*				~example() { destruct(); }
+*			};
+*
 */
 class cObject : public cRender
 {
 public:
-	/* Sets the size to _sx x _sy
+	/** Sets the size to _sx x _sy
 	*/
 	cObject(int _sx, int _sy);
 
diff --git a/cObjectHandler.h b/cObjectHandler.h
index 47e138c..6dda0a8 100644
--- a/cObjectHandler.h
+++ b/cObjectHandler.h
@@ -12,27 +12,32 @@
 using namespace std;
 
 
-/** Manages cObjects and writes them to screenbuffer
-* forwards input events to cObjects
+/**
+* Manages cObject and cWiremesh and writes them to a cRender framebuffer.
+* forwards input events to corresponding cObject.
 */
 class cObjectHandler
 {
 public:
-	/** *_render: pointer to instance of cRender all objects will be written to
+	/**
+	* *_render: pointer to instance of cRender all objects will be written to
 	*/
 	cObjectHandler(cRender *_render);
 
-	/** Adds _object to managed objects vector
+	/**
+	* Adds _object to managed objects vector
 	* returns Identifier for newly created vector
 	*/
 	int createObject(cObject *_object);
 
-	/** Alters position of _object by _pos either relative to old position or Absolute
+	/**
+	* Alters position of _object by _pos either relative to old position or Absolute
 	* Depending on selected _mode (_MOVE_RELATIVE / _MOVE_ABSOLUTE).
 	*/
 	int moveObject(int _object, sPos _pos, int _mode);
 
- /** removes _object from vector after deleting it
+ /**
+ * removes _object from vector after deleting it
  */
 	int destroyObject(int _object);
 
@@ -48,26 +53,31 @@ public:
 	int destroyWiremesh(int _mesh);
 
 
-	/** writes all objects in objects[] to render buffer
+	/**
+	* writes all objects in objects[] to render buffer
 	*/
 	int write();
 
 
-	/** Calls onClick of cObject at _pos, focuses Object
+	/**
+	* Calls onClick of cObject at _pos, focuses Object
 	* returns 0 if successfull, 1 if no Object is at _pos
 	*/
 	int clickEvent(sPos _pos, unsigned int _button);
 
-	/** Calls onChar of active cObject, default 0
+	/**
+	* Calls onChar of active cObject, default 0
 	* returns 0 if successfull, 1 if no Object or destroyed Object is empty
 	*/
 	int charEvent(unsigned char _c);
 
-	/** Focuses next Object
+	/**
+	* Focuses next Object
 	*/
 	void focusNext();
 
-	/**Focuses Object by id.
+	/**
+	* Focuses Object by id.
 	* 0 is empty by default and can be used to unfocus
 	*/
 	void focus(unsigned int _id);
diff --git a/cRender.h b/cRender.h
index d481bf2..415db6e 100644
--- a/cRender.h
+++ b/cRender.h
@@ -63,6 +63,8 @@ struct sPos
 	int y;
 };
 /** cRender manages a framebuffer the size of the console (window) it is run in.
+*
+* puts console in alternate screen mode
 */
 class cRender
 {
diff --git a/cWiremesh.h b/cWiremesh.h
index 320a141..82d3bd6 100644
--- a/cWiremesh.h
+++ b/cWiremesh.h
@@ -42,6 +42,9 @@ struct sVector
   WORD color;
 };
 
+/**
+* cWiremesh stores 3D objects as multiple vectors. it can write itself on a cRender framebuffer.
+*/
 class cWiremesh
 {
 public:
@@ -50,10 +53,22 @@ public:
 
   virtual ~cWiremesh();
 
+  /**
+  * Add a line from _origin to (_origin + _vector) in 3D space.
+  */
   void addVector(sCoord3d _origin, sCoord3d _vector, char _char, WORD _color);
 
+  /**
+  * Rotates by (x,y,z) degrees around the corresponding axis.
+  * Rotation is stored seperatately from original vectors while they stay untouched to prevent growing rounding errors by repeated rotation.
+  *
+  * Rotation is applied relative to the origin of this wiremsh.
+  */
   void rotate(sCoord3d _val);
 
+  /**
+  * Scales by _scalar. The scalar is directly applied to all vectors. Be wary of growing rounding errors!
+  */
   void scale(float _scalar);
 
   sCoord3d getPosition();
@@ -62,8 +77,15 @@ public:
 
   void setPosition(sCoord3d _pos);
 
+  /**
+  * clear this wiremesh
+  */
   void reset();
 
+  /**
+  * Translates wiremesh into 2D space after applying rotation to each vector.
+  * The vanishing point is set to the center of _render with depth _DEPTH. Alter _DEPTH to achieve optimal resultst.
+  */
   void write(cRender *_render);
 
 protected:
diff --git a/testobject.h b/testobject.h
deleted file mode 100644
index 80882b7..0000000
--- a/testobject.h
+++ /dev/null
@@ -1,37 +0,0 @@
-#pragma once
-
-#include "cObject.h"
-#include <string>
-
-class testobject : cObject
-{
-
-public:
-  testobject()
-  {
-    setSize(10,5);
-    cc = 0;
-
-    drawRectangle('#', NULL, {0,0}, {9,4}, _COL_GREEN, _COL_DEFAULT);
-  }
-
-  ~testobject()
-  {
-    destruct();
-  }
-
-  virtual void onClick(sPos _pos, unsigned int _button)
-  {
-    cc++;
-    drawText(std::to_string(cc), {2,2}, _COL_RED);
-
-    drawPoint('Q', _pos, true, _COL_YELLOW);
-  }
-
-	virtual void onChar(unsigned char _c)
-  {
-    drawPoint(_c, {1,1},true, _COL_BLUE);
-  }
-private:
-  int cc;
-};