[Documentation] - create module 'libamb'
authorKevron Rees <tripzero.kev@gmail.com>
Fri, 16 Jan 2015 16:12:18 +0000 (08:12 -0800)
committerKevron Rees <tripzero.kev@gmail.com>
Fri, 16 Jan 2015 16:12:18 +0000 (08:12 -0800)
README.md
lib/abstractpropertytype.h
lib/ambplugin.h
lib/ambpluginimpl.h
lib/debugout.h

index b32a3b2..65479f1 100644 (file)
--- a/README.md
+++ b/README.md
@@ -60,7 +60,7 @@ You will also need to edit your config to enable the Qt-based mainloop:
 
 ~~~~~~~~~~~~~{.json}
 {
-       "mainloop" : "/usr/lib/i386-linux-gnu/automotive-message-broker/qtmainloopplugin.so",
+       "mainloop" : "/usr/lib/x86_64-linux-gnu/automotive-message-broker/qtmainloopplugin.so",
        "plugins" : "/etc/ambd/plugins.d"
 }
 ~~~~~~~~~~~~~
index a097c14..bfdd45a 100644 (file)
@@ -76,12 +76,16 @@ public:
         */
        enum Priority
        {
-               Normal = 0, /*!< normal priority.  This is default */
-               Low, /*!< Low priority. */
-               High, /*!< High priority*/
-               Instant /*!< Instant.  Using this priority is not thread safe.  This is typically used for
-                                *    Properties that need to be deterministic.
-                                */
+               /*!< normal priority.  This is default */
+               Normal = 0,
+               /*!< Low priority. */
+               Low,
+               /*!< High priority*/
+               High,
+               /*!< Instant.  Using this priority is not thread safe.  This is typically used for
+                *    Properties that need to be deterministic.
+                */
+               Instant
        };
 
        AbstractPropertyType(std::string property)
index 8c16dbf..d73ed8d 100644 (file)
@@ -54,7 +54,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  *     new AmbPlugin<MyPlugin>(routingengine, config);
  * }
  * \endcode
- *
+ * \addtogroup libamb
  *  @{
  */
 
index 94245a0..9bd3c2d 100644 (file)
@@ -21,7 +21,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 
 #include "abstractsource.h"
 
-/*! \addtogroup libAMB
+/*! \addtogroup libamb
  *  @{
  */
 
index d6a49e2..1e31ff8 100644 (file)
@@ -30,7 +30,12 @@ using namespace std;
 
 void debugOut(const string &message);
 
+/*! \addtogroup libamb
+ *  @{
+ */
+
 /*!
+ * \file debugout.h
  * \brief The DebugOut class represents a class used for outputing debug information
  * The specified debug level will only be outputed if the debug level is => the debug threshhold
  * Here's a simple example:
@@ -178,8 +183,6 @@ private:
        int mDebugLevel;
 };
 
-
-
-
-
 #endif
+
+/** @} */