working on docs

stactiverecord/query.h

@@ -58,19 +58,19 @@ namespace stactiverecord {
 
     /** Create query object 
      * @param _key The key being queried
-     * @param _value The exact value to match for the given key.
+     * @param _ivalue The exact value to match for the given key.
      */
     Q(std::string _key, int _ivalue) : key(_key), ivalue(_ivalue) { ct = INTEGER; where = equals(_ivalue); };
 
     /** Create query object 
      * @param _key The key being queried
-     * @param _value The exact value to match for the given key.
+     * @param _dtvalue The exact value to match for the given key.
      */
     Q(std::string _key, DateTime _dtvalue) : key(_key), dtvalue(_dtvalue) { ct = DATETIME; where = equals(_dtvalue); };
 
     /** Create query object.
      * @param _key The key being queried
-     * @param _value The exact value to match for the given key.
+     * @param _bvalue The exact value to match for the given key.
      */
     Q(std::string _key, bool _bvalue) : key(_key) {
       ivalue = (_bvalue) ? 1 : 0;
@@ -89,7 +89,6 @@ namespace stactiverecord {
 
     /** using the db, find all records that match
      * @param classname The classname to test
-     * @param db The Sar_Dbi object - it can be directly queried
      */
     SarVector<int> test(std::string classname);
 

stactiverecord/record.h

@@ -26,6 +26,11 @@ Created by bmuller <bmuller@butterfat.net>
 */
 
 namespace stactiverecord {
+/** 
+    All objects should extend Record.  See the simple example in the 
+    examples folder to get started.
+ **/
+
   template <class Klass>
   class Record : public CUDPropertyRegister {
   private:

stactiverecord/storage/sar_dbi.cpp

@@ -25,8 +25,8 @@ namespace stactiverecord {
     throw Sar_InvalidConfigurationException("DB type of \"" + configparts[0] + "\" not recognized.");
   };
 
-  /** parse scheme://[user[:password]@host[:port]/]database into a hashmap that can contain the following
-      keys: user, password, host, port, database
+  /** @param config The db configuration - "scheme://[user[:password]@host[:port]/]database" 
+      \returns A hashmap that can contain the following keys: user, password, host, port, database
   */
   SarMap<std::string> Sar_Dbi::parseconfig(std::string config) {
     SarMap<std::string> result;