Fix doxygen generation, add main page.

Jojo-1000 · Moritz Wirger
1 parent 844af4db
Showing 4 changed files with 227 additions and 85 deletions
.gitignore
Doxyfile
README.md
doc/markdown/Mainpage.md
@@ -31,6 +31,8 @@
 # build directory
 /build*
+# Generated documentation
+/doc/html
 # General
 .DS_Store
-# Doxyfile 1.8.13
+# Doxyfile 1.8.11
 # This file describes the settings to be used by the documentation system
 # doxygen (www.doxygen.org) for a project.
@@ -38,20 +38,20 @@ PROJECT_NAME           = hueplusplus
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
-PROJECT_NUMBER         =
+PROJECT_NUMBER         = 
 # 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
 # quick idea about the purpose of the project. Keep the description short.
-PROJECT_BRIEF          =
+PROJECT_BRIEF          = 
 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
 # in the documentation. The maximum height of the logo should not exceed 55
 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
 # the logo to the output directory.
-PROJECT_LOGO           =
+PROJECT_LOGO           = 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
 # into which the generated documentation will be written. If a relative path is
@@ -162,7 +162,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        = 
 # 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
@@ -171,7 +171,7 @@ STRIP_FROM_PATH        =
 # specify the list of include paths that are normally passed to the compiler
 # using the -I flag.
-STRIP_FROM_INC_PATH    =
+STRIP_FROM_INC_PATH    = 
 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
 # less readable) file names. This can be useful is your file systems doesn't
@@ -238,13 +238,13 @@ TAB_SIZE               = 4
 # "Side Effects:". You can put \n's in the value part of an alias to insert
 # newlines.
-ALIASES                =
+ALIASES                = 
 # This tag can be used to specify a number of word-keyword mappings (TCL only).
 # A mapping has the form "name=value". For example adding "class=itcl::class"
 # will allow you to use the command class in the itcl::class meaning.
-TCL_SUBST              =
+TCL_SUBST              = 
 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
 # only. Doxygen will then generate output that is more tailored for C. For
@@ -291,7 +291,7 @@ OPTIMIZE_OUTPUT_VHDL   = NO
 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
 # the files are not read by doxygen.
-EXTENSION_MAPPING      =
+EXTENSION_MAPPING      = 
 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
 # according to the Markdown format, which allows for more readable
@@ -303,15 +303,6 @@ EXTENSION_MAPPING      =
 MARKDOWN_SUPPORT       = YES
-# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
-# to that level are automatically included in the table of contents, even if
-# they do not have an id attribute.
-# Note: This feature currently applies only to Markdown headings.
-# Minimum value: 0, maximum value: 99, default value: 0.
-# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
-
-TOC_INCLUDE_HEADINGS   = 0
-
 # When enabled doxygen tries to link words that correspond to documented
 # classes, or namespaces to their corresponding documentation. Such a link can
 # be prevented in individual cases by putting a % sign in front of the word or
@@ -648,7 +639,7 @@ GENERATE_DEPRECATEDLIST= YES
 # sections, marked by \if <section_label> ... \endif and \cond <section_label>
 # ... \endcond blocks.
-ENABLED_SECTIONS       =
+ENABLED_SECTIONS       = 
 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
 # initial value of a variable or macro / define can have for it to appear in the
@@ -690,7 +681,7 @@ SHOW_NAMESPACES        = YES
 # by doxygen. Whatever the program writes to standard output is used as the file
 # version. For an example see the documentation.
-FILE_VERSION_FILTER    =
+FILE_VERSION_FILTER    = 
 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
 # by doxygen. The layout file controls the global structure of the generated
@@ -703,7 +694,7 @@ FILE_VERSION_FILTER    =
 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
 # tag is left empty.
-LAYOUT_FILE            =
+LAYOUT_FILE            = 
 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
 # the reference definitions. This must be a list of .bib files. The .bib
@@ -713,7 +704,7 @@ LAYOUT_FILE            =
 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
 # search path. See also \cite for info how to create references.
-CITE_BIB_FILES         =
+CITE_BIB_FILES         = 
 #---------------------------------------------------------------------------
 # Configuration options related to warning and progress messages
@@ -778,7 +769,7 @@ WARN_FORMAT            = &quot;$file:$line: $text&quot;
 # messages should be written. If left blank the output is written to standard
 # error (stderr).
-WARN_LOGFILE           =
+WARN_LOGFILE           = 
 #---------------------------------------------------------------------------
 # Configuration options related to the input files
@@ -790,7 +781,9 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
-INPUT                  = hueplusplus
+INPUT                  = include/hueplusplus \
+                         src \
+                         doc/markdown
 # 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
@@ -812,8 +805,8 @@ INPUT_ENCODING         = UTF-8
 # If left blank the following patterns are tested:*.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 and *.qsf.
+# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl,
+# *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js.
 FILE_PATTERNS          = *.c \
                          *.cc \
@@ -873,8 +866,7 @@ RECURSIVE              = YES
 # Note that relative paths are relative to the directory from which doxygen is
 # run.
-EXCLUDE                = hueplusplus/include/json \
-                         hueplusplus/test \
+EXCLUDE                = 
 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
 # directories that are symbolic links (a Unix file system feature) are excluded
@@ -890,7 +882,7 @@ EXCLUDE_SYMLINKS       = NO
 # Note that the wildcards are matched against the file with absolute path, so to
 # exclude all test directories for example use the pattern */test/*
-EXCLUDE_PATTERNS       =
+EXCLUDE_PATTERNS       = 
 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
 # (namespaces, classes, functions, etc.) that should be excluded from the
@@ -907,7 +899,7 @@ EXCLUDE_SYMBOLS        = *::detail
 # that contain example code fragments that are included (see the \include
 # command).
-EXAMPLE_PATH           =
+EXAMPLE_PATH           = 
 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
@@ -927,7 +919,7 @@ EXAMPLE_RECURSIVE      = NO
 # that contain images that are to be included in the documentation (see the
 # \image command).
-IMAGE_PATH             =
+IMAGE_PATH             = 
 # The INPUT_FILTER tag can be used to specify a program that doxygen should
 # invoke to filter for each input file. Doxygen will invoke the filter program
@@ -948,7 +940,7 @@ IMAGE_PATH             =
 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
 # properly processed by doxygen.
-INPUT_FILTER           =
+INPUT_FILTER           = 
 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
 # basis. Doxygen will compare the file name with each pattern and apply the
@@ -961,7 +953,7 @@ INPUT_FILTER           =
 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
 # properly processed by doxygen.
-FILTER_PATTERNS        =
+FILTER_PATTERNS        = 
 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
 # INPUT_FILTER) will also be used to filter the input files that are used for
@@ -976,14 +968,14 @@ FILTER_SOURCE_FILES    = NO
 # *.ext= (so without naming a filter).
 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
-FILTER_SOURCE_PATTERNS =
+FILTER_SOURCE_PATTERNS = 
 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
 # is part of the input, its contents will be placed on the main page
 # (index.html). This can be useful if you have a project on for instance GitHub
 # and want to reuse the introduction page also for the doxygen output.
-USE_MDFILE_AS_MAINPAGE =
+USE_MDFILE_AS_MAINPAGE = Mainpage.md
 #---------------------------------------------------------------------------
 # Configuration options related to source browsing
@@ -1088,7 +1080,7 @@ CLANG_ASSISTED_PARSING = NO
 # specified with INPUT and INCLUDE_PATH.
 # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
-CLANG_OPTIONS          =
+CLANG_OPTIONS          = 
 #---------------------------------------------------------------------------
 # Configuration options related to the alphabetical class index
@@ -1114,7 +1106,7 @@ COLS_IN_ALPHA_INDEX    = 5
 # while generating the index headers.
 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
-IGNORE_PREFIX          =
+IGNORE_PREFIX          = 
 #---------------------------------------------------------------------------
 # Configuration options related to the HTML output
@@ -1158,7 +1150,7 @@ HTML_FILE_EXTENSION    = .html
 # of the possible markers and block names see the documentation.
 # This tag requires that the tag GENERATE_HTML is set to YES.
-HTML_HEADER            =
+HTML_HEADER            = 
 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
 # generated HTML page. If the tag is left blank doxygen will generate a standard
@@ -1168,7 +1160,7 @@ HTML_HEADER            =
 # that doxygen normally uses.
 # This tag requires that the tag GENERATE_HTML is set to YES.
-HTML_FOOTER            =
+HTML_FOOTER            = 
 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
 # sheet that is used by each HTML page. It can be used to fine-tune the look of
@@ -1180,7 +1172,7 @@ HTML_FOOTER            =
 # obsolete.
 # This tag requires that the tag GENERATE_HTML is set to YES.
-HTML_STYLESHEET        =
+HTML_STYLESHEET        = 
 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
 # cascading style sheets that are included after the standard style sheets
@@ -1193,7 +1185,7 @@ HTML_STYLESHEET        =
 # list). For an example see the documentation.
 # This tag requires that the tag GENERATE_HTML is set to YES.
-HTML_EXTRA_STYLESHEET  =
+HTML_EXTRA_STYLESHEET  = 
 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
 # other source files which should be copied to the HTML output directory. Note
@@ -1203,7 +1195,7 @@ HTML_EXTRA_STYLESHEET  =
 # files will be copied as-is; there are no commands or markers available.
 # This tag requires that the tag GENERATE_HTML is set to YES.
-HTML_EXTRA_FILES       =
+HTML_EXTRA_FILES       = 
 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
 # will adjust the colors in the style sheet and background images according to
@@ -1332,7 +1324,7 @@ GENERATE_HTMLHELP      = NO
 # written to the html output directory.
 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
-CHM_FILE               =
+CHM_FILE               = 
 # The HHC_LOCATION tag can be used to specify the location (absolute path
 # including file name) of the HTML help compiler (hhc.exe). If non-empty,
@@ -1340,7 +1332,7 @@ CHM_FILE               =
 # The file has to be specified with full path.
 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
-HHC_LOCATION           =
+HHC_LOCATION           = 
 # The GENERATE_CHI flag controls if a separate .chi index file is generated
 # (YES) or that it should be included in the master .chm file (NO).
@@ -1353,7 +1345,7 @@ GENERATE_CHI           = NO
 # and project file content.
 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
-CHM_INDEX_ENCODING     =
+CHM_INDEX_ENCODING     = 
 # The BINARY_TOC flag controls whether a binary table of contents is generated
 # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
@@ -1384,7 +1376,7 @@ GENERATE_QHP           = NO
 # the HTML output folder.
 # This tag requires that the tag GENERATE_QHP is set to YES.
-QCH_FILE               =
+QCH_FILE               = 
 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
 # Project output. For more information please see Qt Help Project / Namespace
@@ -1409,7 +1401,7 @@ QHP_VIRTUAL_FOLDER     = doc
 # filters).
 # This tag requires that the tag GENERATE_QHP is set to YES.
-QHP_CUST_FILTER_NAME   =
+QHP_CUST_FILTER_NAME   = 
 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
 # custom filter to add. For more information please see Qt Help Project / Custom
@@ -1417,21 +1409,21 @@ QHP_CUST_FILTER_NAME   =
 # filters).
 # This tag requires that the tag GENERATE_QHP is set to YES.
-QHP_CUST_FILTER_ATTRS  =
+QHP_CUST_FILTER_ATTRS  = 
 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
 # project's filter section matches. Qt Help Project / Filter Attributes (see:
 # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
 # This tag requires that the tag GENERATE_QHP is set to YES.
-QHP_SECT_FILTER_ATTRS  =
+QHP_SECT_FILTER_ATTRS  = 
 # The QHG_LOCATION tag can be used to specify the location of Qt's
 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
 # generated .qhp file.
 # This tag requires that the tag GENERATE_QHP is set to YES.
-QHG_LOCATION           =
+QHG_LOCATION           = 
 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
 # generated, together with the HTML files, they form an Eclipse help plugin. To
@@ -1564,7 +1556,7 @@ MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
 # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
 # This tag requires that the tag USE_MATHJAX is set to YES.
-MATHJAX_EXTENSIONS     =
+MATHJAX_EXTENSIONS     = 
 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
 # of code that will be used on startup of the MathJax code. See the MathJax site
@@ -1572,7 +1564,7 @@ MATHJAX_EXTENSIONS     =
 # example see the documentation.
 # This tag requires that the tag USE_MATHJAX is set to YES.
-MATHJAX_CODEFILE       =
+MATHJAX_CODEFILE       = 
 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
 # the HTML output. The underlying search engine uses javascript and DHTML and
@@ -1632,7 +1624,7 @@ EXTERNAL_SEARCH        = NO
 # Searching" for details.
 # This tag requires that the tag SEARCHENGINE is set to YES.
-SEARCHENGINE_URL       =
+SEARCHENGINE_URL       = 
 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
 # search data is written to a file for indexing by an external tool. With the
@@ -1648,7 +1640,7 @@ SEARCHDATA_FILE        = searchdata.xml
 # projects and redirect the results back to the right project.
 # This tag requires that the tag SEARCHENGINE is set to YES.
-EXTERNAL_SEARCH_ID     =
+EXTERNAL_SEARCH_ID     = 
 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
 # projects other than the one defined by this configuration file, but that are
@@ -1658,7 +1650,7 @@ EXTERNAL_SEARCH_ID     =
 # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
 # This tag requires that the tag SEARCHENGINE is set to YES.
-EXTRA_SEARCH_MAPPINGS  =
+EXTRA_SEARCH_MAPPINGS  = 
 #---------------------------------------------------------------------------
 # Configuration options related to the LaTeX output
@@ -1667,7 +1659,7 @@ EXTRA_SEARCH_MAPPINGS  =
 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
 # The default value is: YES.
-GENERATE_LATEX         = YES
+GENERATE_LATEX         = NO
 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
@@ -1722,7 +1714,7 @@ PAPER_TYPE             = a4
 # If left blank no extra packages will be included.
 # This tag requires that the tag GENERATE_LATEX is set to YES.
-EXTRA_PACKAGES         =
+EXTRA_PACKAGES         = 
 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
 # generated LaTeX document. The header should contain everything until the first
@@ -1738,7 +1730,7 @@ EXTRA_PACKAGES         =
 # to HTML_HEADER.
 # This tag requires that the tag GENERATE_LATEX is set to YES.
-LATEX_HEADER           =
+LATEX_HEADER           = 
 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
 # generated LaTeX document. The footer should contain everything after the last
@@ -1749,7 +1741,7 @@ LATEX_HEADER           =
 # Note: Only use a user-defined footer if you know what you are doing!
 # This tag requires that the tag GENERATE_LATEX is set to YES.
-LATEX_FOOTER           =
+LATEX_FOOTER           = 
 # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
 # LaTeX style sheets that are included after the standard style sheets created
@@ -1760,7 +1752,7 @@ LATEX_FOOTER           =
 # list).
 # This tag requires that the tag GENERATE_LATEX is set to YES.
-LATEX_EXTRA_STYLESHEET =
+LATEX_EXTRA_STYLESHEET = 
 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
 # other source files which should be copied to the LATEX_OUTPUT output
@@ -1768,7 +1760,7 @@ LATEX_EXTRA_STYLESHEET =
 # markers available.
 # This tag requires that the tag GENERATE_LATEX is set to YES.
-LATEX_EXTRA_FILES      =
+LATEX_EXTRA_FILES      = 
 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
@@ -1876,14 +1868,14 @@ RTF_HYPERLINKS         = NO
 # default style sheet that doxygen normally uses.
 # This tag requires that the tag GENERATE_RTF is set to YES.
-RTF_STYLESHEET_FILE    =
+RTF_STYLESHEET_FILE    = 
 # Set optional variables used in the generation of an RTF document. Syntax is
 # similar to doxygen's config file. A template extensions file can be generated
 # using doxygen -e rtf extensionFile.
 # This tag requires that the tag GENERATE_RTF is set to YES.
-RTF_EXTENSIONS_FILE    =
+RTF_EXTENSIONS_FILE    = 
 # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
 # with syntax highlighting in the RTF output.
@@ -1928,7 +1920,7 @@ MAN_EXTENSION          = .3
 # MAN_EXTENSION with the initial . removed.
 # This tag requires that the tag GENERATE_MAN is set to YES.
-MAN_SUBDIR             =
+MAN_SUBDIR             = 
 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
 # will generate one additional man file for each entity documented in the real
@@ -2041,7 +2033,7 @@ PERLMOD_PRETTY         = YES
 # overwrite each other's variables.
 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
-PERLMOD_MAKEVAR_PREFIX =
+PERLMOD_MAKEVAR_PREFIX = 
 #---------------------------------------------------------------------------
 # Configuration options related to the preprocessor
@@ -2082,7 +2074,7 @@ SEARCH_INCLUDES        = YES
 # preprocessor.
 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
-INCLUDE_PATH           =
+INCLUDE_PATH           = 
 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
 # patterns (like *.h and *.hpp) to filter out the header-files in the
@@ -2090,7 +2082,7 @@ INCLUDE_PATH           =
 # used.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
-INCLUDE_FILE_PATTERNS  =
+INCLUDE_FILE_PATTERNS  = 
 # The PREDEFINED tag can be used to specify one or more macro names that are
 # defined before the preprocessor is started (similar to the -D option of e.g.
@@ -2100,7 +2092,7 @@ INCLUDE_FILE_PATTERNS  =
 # recursively expanded use the := operator instead of the = operator.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
-PREDEFINED             =
+PREDEFINED             = 
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
 # tag can be used to specify a list of macro names that should be expanded. The
@@ -2109,7 +2101,7 @@ PREDEFINED             =
 # definition found in the source code.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
-EXPAND_AS_DEFINED      =
+EXPAND_AS_DEFINED      = 
 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
 # remove all references to function-like macros that are alone on a line, have
@@ -2138,13 +2130,13 @@ SKIP_FUNCTION_MACROS   = YES
 # the path). If a tag file is not located in the directory in which doxygen is
 # run, you must also specify the path to the tagfile here.
-TAGFILES               =
+TAGFILES               = 
 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
 # tag file that is based on the input files it reads. See section "Linking to
 # external documentation" for more information about the usage of tag files.
-GENERATE_TAGFILE       =
+GENERATE_TAGFILE       = 
 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
 # the class index. If set to NO, only the inherited external classes will be
@@ -2193,14 +2185,14 @@ CLASS_DIAGRAMS         = NO
 # the mscgen tool resides. If left empty the tool is assumed to be found in the
 # default search path.
-MSCGEN_PATH            =
+MSCGEN_PATH            = 
 # You can include diagrams made with dia in doxygen documentation. Doxygen will
 # then run dia to produce the diagram and insert it in the documentation. The
 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
 # If left empty dia is assumed to be found in the default search path.
-DIA_PATH               =
+DIA_PATH               = 
 # If set to YES the inheritance and collaboration graphs will hide inheritance
 # and usage relations if the target is undocumented or is not a class.
@@ -2249,7 +2241,7 @@ DOT_FONTSIZE           = 10
 # the path where dot can find it using this tag.
 # This tag requires that the tag HAVE_DOT is set to YES.
-DOT_FONTPATH           =
+DOT_FONTPATH           = 
 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
 # each documented class showing the direct and indirect inheritance relations.
@@ -2400,19 +2392,19 @@ DOT_PATH               = /usr/local/bin
 # command).
 # This tag requires that the tag HAVE_DOT is set to YES.
-DOTFILE_DIRS           =
+DOTFILE_DIRS           = 
 # The MSCFILE_DIRS tag can be used to specify one or more directories that
 # contain msc files that are included in the documentation (see the \mscfile
 # command).
-MSCFILE_DIRS           =
+MSCFILE_DIRS           = 
 # The DIAFILE_DIRS tag can be used to specify one or more directories that
 # contain dia files that are included in the documentation (see the \diafile
 # command).
-DIAFILE_DIRS           =
+DIAFILE_DIRS           = 
 # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
 # path where java can find the plantuml.jar file. If left blank, it is assumed
@@ -2420,17 +2412,12 @@ DIAFILE_DIRS           =
 # generate a warning when it encounters a \startuml command in this case and
 # will not generate output for the diagram.
-PLANTUML_JAR_PATH      =
-
-# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
-# configuration file for plantuml.
-
-PLANTUML_CFG_FILE      =
+PLANTUML_JAR_PATH      = 
 # When using plantuml, the specified paths are searched for files specified by
 # the !include statement in a plantuml block.
-PLANTUML_INCLUDE_PATH  =
+PLANTUML_INCLUDE_PATH  = 
 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
 # that will be shown in the graph. If the number of nodes in a graph becomes
@@ -101,7 +101,7 @@ If you want to know more about all functions just look inside the doxygen docume
 ## Build and install
 ### Basic installation
-If you want to build the library you can use cmake (at least version 2.8.3). First create a build folder and then execute cmake.
+If you want to build the library you can use cmake (at least version 3.8). First create a build folder and then execute cmake.
 ```bash
 mkdir build
 cd build
+# Documentation for the hueplusplus library
+A simple and easy to use library for Philips Hue Lights.
+
+## Features
+* find bridges with SSDP or set an ip manually
+* function to assign a username or set one manually
+* all common light functions (brightness, color, temperature)
+* extended alert() functions, which alert in a specific color (good for notifications)
+* documented with doxygen
+* tested with google test, google mock and gcov/lcov
+
+## Compatibility
+* Linux
+* Windows
+* MacOS
+* Espressif ESP32 SDK & Arduino
+
+## How to use
+### <a name="searchingBridges"></a>Searching for Bridges
+To start searching for a Hue Bridge you will need to choose an IHttpHandler and create one. The options are a [WinHttpHandler](@ref hueplusplus::WinHttpHandler) (for windows) or a [LinHttpHandler](@ref hueplusplus::LinHttpHandler) (for linux or linux-like).
+
+Then create a [HueFinder](@ref hueplusplus::HueFinder) object with the handler.
+The handler is needed, because it tells the finder which functions to use to communicate with a bridge or your local network.
+After that you can call [FindBridges()](@ref hueplusplus::HueFinder::FindBridges), which will return a vector containing the ip and mac address of all found Bridges.
+```{.cpp}
+// For windows use std::make_shared<hueplusplus::WinHttpHandler>();
+handler = std::make_shared<hueplusplus::LinHttpHandler>();
+hueplusplus::HueFinder finder(handler);
+std::vector<hueplusplus::HueFinder::HueIdentification> bridges = finder.FindBridges();
+if (bridges.empty())
+{
+	std::cerr << "No bridges found\n";
+	return;
+}
+
+```
+
+### Authenticate Bridges
+If you have found the Bridge you were looking for, you can then move on with the authentication process.
+To get a new username from the Bridge (for now) you simply call [GetBridge(bridges[\<index\>])](@ref hueplusplus::HueFinder::GetBridge),
+where index is your preferred Bridge from the part [Searching for Bridges](#searchingBridges). This requires the user to press the link button.
+```{.cpp}
+hueplusplus::Hue bridge = finder.GetBridge(bridges[0]);
+```
+If you on the other hand already have a username you can add your bridge like so
+```{.cpp}
+finder.AddUsername(bridges[0].mac, "<username>");
+hueplusplus::Hue bridge = finder.GetBridge(bridges[0]);
+```
+If you do not want to use the HueFinder or you already know the ip and username of your bridge you have the option to create your own Hue object.
+Here you will need to provide the ip address, the port number, a username and an HttpHandler
+```{.cpp}
+// For windows use std::make_shared<hueplusplus::WinHttpHandler>();
+handler = std::make_shared<hueplusplus::LinHttpHandler>();
+hueplusplus::Hue bridge("192.168.2.102", 80, "<username>", handler);
+```
+
+### Controlling lights
+If you have your Bridge all set up, you can now control its lights.
+For that create a new HueLight object and call [getLight(\<id\>)](@ref hueplusplus::Hue::getLight) on your bridge object to get a reference to a specific light, where id
+is the id of the light set internally by the Hue Bridge.
+```{.cpp}
+hueplusplus::HueLight light1 = bridge.getLight(1);
+```
+If you don't know the id of a specific light or want to get an overview over all lights that are controlled by your bridge, 
+you can get a vector containing them by calling [getAllLights()](@ref hueplusplus::Hue::getAllLights) on your bridge object. If no lights are found the vector will be empty.
+```{.cpp}
+std::vector<std::reference_wrapper<hueplusplus::HueLight>> lights = bridge.getAllLights();
+```
+If you now want to control a light, call a specific function of it.
+```{.cpp}
+light1.On();
+light1.setBrightness(120);
+light1.alertHueSaturation(25500, 255);
+light1.setColorLoop(true);
+light1.setColorRGB(255, 128, 0);
+lights[1].Off();
+lights.at(1).setColorHue(4562);
+```
+But keep in mind that some light types do not have all functions available. So you might call a
+specific function, but nothing will happen. For that you might want to check what type
+of a light you are controlling. For that you can call the function [getColorType()](@ref hueplusplus::HueLight::getColorType()), which will return
+a ColorType.
+```{.cpp}
+hueplusplus::ColorType type1 = light1.getColorType();
+```
+There's also a new way to check whether specific functions of a light are available:
+```{.cpp}
+light1.hasBrightnessControl();
+light1.hasTemperatureControl();
+light1.hasColorControl();
+```
+These will either return true(light has specified function) or false(light lacks specified function).
+
+## Build and install
+### Basic installation
+If you want to build the library you can use cmake (at least version 3.8). First create a build folder and then execute cmake.
+```bash
+mkdir build
+cd build
+cmake ..
+```
+Then compile the code with make. If you are inpatient use the option -j\<number\>, where number specifies how many files are compiled at the same time. Note this number should not exceed the number of cores*2 of your machine.
+```bash
+make
+```
+```bash
+make -j4
+```
+If you want to install the library use
+```bash
+make install
+```
+To remove it
+```bash
+make uninstall
+```
+
+### Advanced usage
+If you have a project that already uses CMake you probably want to add the hueplusplus library directly in your cmake file.
+For that the best way is to use find_package().
+When cmake finds the hueplusplus library you can then link against either the shared or static version of the library.
+```cmake
+find_package(hueplusplus REQUIRED)
+
+target_link_libraries(<executable> PUBLIC hueplusplusstatic)
+```
+But this will only work if the hueplusplus library is already installed.
+To get around this problem there is a pretty awesome way.
+If you have the hueplusplus repository included in your project repository (as a submodule) or know where the folder lives you can do the following:
+```cmake
+find_package(hueplusplus QUIET)
+if(NOT hueplusplus_FOUND)
+    message(STATUS "-- hueplusplus not found, building it")
+    add_subdirectory("${CMAKE_CURRENT_SOURCE_DIR}/<path to directory>/hueplusplus" "${CMAKE_CURRENT_BINARY_DIR}/hueplusplus")
+endif()
+
+target_link_libraries(<executable> PUBLIC hueplusplusstatic)
+```
+This will check if the hueplusplus library was found by find_package() and if not it will use the specified path to the library source and compile it during the build process.
+
+### Running tests
+If you additionally want to run the tests use cmake with the option -Dhueplusplus_TESTS=ON. Testing is done with Google gtest and gmock. Note that you wont need to install gtest/gmock yourself, because cmake will automatically download them and include them during the build. Since I added a custom target you will only need to call "make unittest" and the tests are compiled and executed.
+```bash
+mkdir build
+cd build
+cmake .. -Dhueplusplus_TESTS=ON
+make unittest
+```
+If you also want to execute coverage tests you will need to install gcov and lcov yourself. To run the coverage test use
+```bash
+make coveragetest
+```