added more documentation for VehicleProperty

diff --git a/CMakeLists.txt b/CMakeLists.txt
index 5ee9627..c8b9482 100644 (file)
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -60,7 +60,6 @@ find_package(Doxygen)
 if(DOXYGEN_FOUND)
        configure_file(${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY)
        add_custom_target(all ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/docs COMMENT "Generating API documentation with Doxygen" VERBATIM)
-
 endif(DOXYGEN_FOUND)
 endif(enable_docs)
 

diff --git a/lib/vehicleproperty.h b/lib/vehicleproperty.h
index 531f03f..0f03ff5 100644 (file)
--- a/lib/vehicleproperty.h
+++ b/lib/vehicleproperty.h
@@ -303,9 +303,17 @@ class VehicleProperty
 public:
        
 
+       /*!
+        * \brief factory constructs a static instance of VehicleProperty.  This should be called once before VehicleProperty is used in the app
+        */
        static void factory();
 
        typedef std::string Property;
+
+       /*!
+        * \brief PropertyTypeFactoryCallback callback used to construct a AbstractPropertyType for a property
+        * \see registerProperty
+        */
        typedef std::function<AbstractPropertyType* (void)> PropertyTypeFactoryCallback;
 
        /// Various property types:
@@ -783,22 +791,32 @@ public:
        /** END PROPERTIES **/
 
 
+       /*!
+        * \brief capabilities
+        * \return returns list of all registered properties
+        * \see VehicleProperty::registerProperty
+        */
        static std::list<VehicleProperty::Property> capabilities();
+
+       /*!
+        * \brief customProperties
+        * \return returns list of custom properties defined by plugins using VehicleProperty::registerProperty
+        */
        static std::list<VehicleProperty::Property> customProperties();
 
-       /*! getPropertyTypeForPropertyNameValue returns an AbstractPropertyType* for the property name
+       /*! \brief getPropertyTypeForPropertyNameValue returns an AbstractPropertyType* for the property name
          * with the value specified by 'value'.  Ownership of the returned AbstractPropertyType* is
          * transfered to the caller.
          */
        static AbstractPropertyType* getPropertyTypeForPropertyNameValue(Property name, std::string value="");
 
-       /*! registerProperty registers properties with the Vehicle Property system.  Returns true if property
+       /*! \brief registerProperty registers properties with the Vehicle Property system.  Returns true if property
         *  has been registered successfully.
-        *  @param name - name of property.  Name cannot match any existing property or it will be rejected and
+        *  \param name - name of property.  Name cannot match any existing property or it will be rejected and
         *  this method will return false.
-        *  @param factor - callback function that returns an AbstractPropertyType representation of the value.
+        *  \param factor - callback function that returns an AbstractPropertyType representation of the value.
         *  custom properties will need to return a custom AbstractPropertyType based object.
-        *  @example :
+        *  \example :
         *
         *  #include <vehicleproperty.h>
         *  #include <abstractpropertytype.h>