Documentation Updates

Doxyfile

@@ -1,7 +1,7 @@
 PROJECT_NAME     = AoSharedServiceLibrary
 OUTPUT_DIRECTORY = docs/html
 WARNINGS         = YES
-INPUT            = aossl/commandline/include aossl/consul/include aossl/http/client/include aossl/http/server/include aossl/logging/include aossl/properties/include aossl/redis/include aossl/uuid/include aossl/zmq/include aossl/neo4j/include aossl/mongo/include
-FILE_PATTERNS    = factory_*.h *_interface.h
+INPUT            = aossl/commandline/include aossl/consul/include aossl/http/client/include aossl/http/server/include aossl/logging/include aossl/properties/include aossl/redis/include aossl/uuid/include aossl/zmq/include aossl/neo4j/include aossl/mongo/include docs/main_page.txt
+FILE_PATTERNS    = factory_*.h *_interface.h *.txt
 INCLUDE_PATH     = aossl
 SEARCHENGINE     = NO

docs/html/latex/classZmqIn.tex

@@ -11,8 +11,7 @@
 
 
 
-Inheritance diagram for Zmq\+In\+:
-\nopagebreak
+Inheritance diagram for Zmq\+In\+:\nopagebreak
 \begin{figure}[H]
 \begin{center}
 \leavevmode
@@ -21,8 +20,7 @@
 \end{figure}
 
 
-Collaboration diagram for Zmq\+In\+:
-\nopagebreak
+Collaboration diagram for Zmq\+In\+:\nopagebreak
 \begin{figure}[H]
 \begin{center}
 \leavevmode

docs/html/latex/classZmqOut.tex

@@ -11,8 +11,7 @@
 
 
 
-Inheritance diagram for Zmq\+Out\+:
-\nopagebreak
+Inheritance diagram for Zmq\+Out\+:\nopagebreak
 \begin{figure}[H]
 \begin{center}
 \leavevmode
@@ -21,8 +20,7 @@
 \end{figure}
 
 
-Collaboration diagram for Zmq\+Out\+:
-\nopagebreak
+Collaboration diagram for Zmq\+Out\+:\nopagebreak
 \begin{figure}[H]
 \begin{center}
 \leavevmode

docs/html/latex/classZmqio.tex

@@ -11,8 +11,7 @@
 
 
 
-Inheritance diagram for Zmqio\+:
-\nopagebreak
+Inheritance diagram for Zmqio\+:\nopagebreak
 \begin{figure}[H]
 \begin{center}
 \leavevmode

docs/html/latex/index.tex

@@ -0,0 +1,4 @@
+\hypertarget{index_over}{}\section{Overview}\label{index_over}
+Welcome to the AO Shared Service Library. This is a framework designed for constructing C++ Microservices. This means smaller, more focused programs that perform a single function well and rely on inter-\/process communications to perform complex tasks.
+
+While designed with a Microservice architecture in mind, A\+O\+S\+SL also seeks to maintain enough flexibility to allow for use with any program architecture and any other libraries. A\+O\+S\+SL uses a plug-\/and-\/play architecture to allow users to pick and choose components they would like to use, and exclude others. This is meant to reduce time-\/to-\/market on C++ Services, and is designed to be easy to use and reliable, while maintaining high performance standards. 

docs/html/latex/refman.tex

@@ -137,6 +137,8 @@
 \hypersetup{pageanchor=true}
 
 %--- Begin generated contents ---
+\chapter{AO Shared Service Library}
+\label{index}\hypertarget{index}{}\input{index}
 \chapter{Hierarchical Index}
 \input{hierarchy}
 \chapter{Class Index}

docs/html/latex/structHttpRequestException.tex

@@ -11,8 +11,7 @@
 
 
 
-Inheritance diagram for Http\+Request\+Exception\+:
-\nopagebreak
+Inheritance diagram for Http\+Request\+Exception\+:\nopagebreak
 \begin{figure}[H]
 \begin{center}
 \leavevmode
@@ -21,8 +20,7 @@
 \end{figure}
 
 
-Collaboration diagram for Http\+Request\+Exception\+:
-\nopagebreak
+Collaboration diagram for Http\+Request\+Exception\+:\nopagebreak
 \begin{figure}[H]
 \begin{center}
 \leavevmode

docs/html/latex/structLoggingException.tex

@@ -11,8 +11,7 @@
 
 
 
-Inheritance diagram for Logging\+Exception\+:
-\nopagebreak
+Inheritance diagram for Logging\+Exception\+:\nopagebreak
 \begin{figure}[H]
 \begin{center}
 \leavevmode
@@ -21,8 +20,7 @@
 \end{figure}
 
 
-Collaboration diagram for Logging\+Exception\+:
-\nopagebreak
+Collaboration diagram for Logging\+Exception\+:\nopagebreak
 \begin{figure}[H]
 \begin{center}
 \leavevmode

docs/html/latex/structMongoException.tex

@@ -11,8 +11,7 @@
 
 
 
-Inheritance diagram for Mongo\+Exception\+:
-\nopagebreak
+Inheritance diagram for Mongo\+Exception\+:\nopagebreak
 \begin{figure}[H]
 \begin{center}
 \leavevmode
@@ -21,8 +20,7 @@
 \end{figure}
 
 
-Collaboration diagram for Mongo\+Exception\+:
-\nopagebreak
+Collaboration diagram for Mongo\+Exception\+:\nopagebreak
 \begin{figure}[H]
 \begin{center}
 \leavevmode

docs/html/latex/structRedisConnectionException.tex

@@ -11,8 +11,7 @@
 
 
 
-Inheritance diagram for Redis\+Connection\+Exception\+:
-\nopagebreak
+Inheritance diagram for Redis\+Connection\+Exception\+:\nopagebreak
 \begin{figure}[H]
 \begin{center}
 \leavevmode
@@ -21,8 +20,7 @@
 \end{figure}
 
 
-Collaboration diagram for Redis\+Connection\+Exception\+:
-\nopagebreak
+Collaboration diagram for Redis\+Connection\+Exception\+:\nopagebreak
 \begin{figure}[H]
 \begin{center}
 \leavevmode

docs/html/latex/structRedisOperationException.tex

@@ -11,8 +11,7 @@
 
 
 
-Inheritance diagram for Redis\+Operation\+Exception\+:
-\nopagebreak
+Inheritance diagram for Redis\+Operation\+Exception\+:\nopagebreak
 \begin{figure}[H]
 \begin{center}
 \leavevmode
@@ -21,8 +20,7 @@
 \end{figure}
 
 
-Collaboration diagram for Redis\+Operation\+Exception\+:
-\nopagebreak
+Collaboration diagram for Redis\+Operation\+Exception\+:\nopagebreak
 \begin{figure}[H]
 \begin{center}
 \leavevmode

docs/main_page.txt

@@ -0,0 +1,38 @@
+/*!
+ *
+ * \mainpage AO Shared Service Library
+ *
+ * ![](https://travis-ci.org/AO-StreetArt/AOSharedServiceLibrary.svg?branch=master)
+ *
+ * \section over Overview
+ *
+ * Welcome to the AO Shared Service Library.  This is a framework designed for constructing C++ Microservices.  This means smaller, more focused programs that perform a single function well and rely on inter-process communications to perform complex tasks.
+ *
+ * While designed with a Microservice architecture in mind, AOSSL also seeks to maintain enough flexibility to allow for use with any program architecture and any other libraries.  AOSSL uses a plug-and-play architecture to allow users to pick and choose components they would like to use, and exclude others.  This is meant to reduce time-to-market on C++ Services, and is designed to be easy to use and reliable, while maintaining high performance standards.
+ *
+ * \section features Features
+ *
+ * \subsection core Core Frameworks
+ *
+ * - ZeroMQ Service Framework
+ * - HTTP Service Framework
+ *
+ * \subsection conn Connections
+ *
+ * - Mongo Interface
+ * - Redis Interface
+ * - Consul Interface
+ * - Neo4j Interface
+ *
+ * \subsection tools Basic Tools
+ *
+ * - Asynchronous Logging Module
+ * - Universally Unique ID Generator
+ * - Command Line Argument Parser
+ * - Properties File Parser
+ *
+ * \subsection platform Platform Support
+ * - Support for Ubuntu 14.04, Ubuntu 16.04, Debian 7, Debian 8, CentOS 7, RHEL 7
+ * - Docker Support
+ *
+ */