Documentation pass for simtime, share/take methods, and knowledge_cast

jredmondson · Jun 19, 2018 · aaca105 · aaca105
1 parent 72b339f
commit aaca105
Show file tree

Hide file tree

Showing 5 changed files with 223 additions and 77 deletions.
diff --git a/include/madara/knowledge/KnowledgeBase.h b/include/madara/knowledge/KnowledgeBase.h
@@ -194,7 +194,7 @@ namespace madara
                      KnowledgeReferenceSettings (false));
 
       /**
-       * Returns a shared_ptr, sharing with the internal one.
+       * @return a shared_ptr, sharing with the internal one.
        * If this record is not a string, returns NULL shared_ptr
        **/
       std::shared_ptr<std::string> share_string(const std::string & key,
@@ -214,7 +214,7 @@ namespace madara
       }
 
       /**
-       * Returns a shared_ptr, sharing with the internal one.
+       * @return a shared_ptr, sharing with the internal one.
        * If this record is not a string, returns NULL shared_ptr
        **/
       std::shared_ptr<std::string> share_string(const VariableReference & key,
@@ -234,8 +234,9 @@ namespace madara
       }
 
       /**
-       * Returns a shared_ptr, while resetting this record to empty.
+       * @return a shared_ptr, while resetting this record to empty.
        * If this record is not a string, returns NULL shared_ptr
+       * and this record is unmodified.
        **/
       std::shared_ptr<std::string> take_string(const std::string & key,
              const KnowledgeReferenceSettings & settings =
@@ -254,8 +255,9 @@ namespace madara
       }
 
       /**
-       * Returns a shared_ptr, while resetting this record to empty.
+       * @return a shared_ptr, while resetting this record to empty.
        * If this record is not a string, returns NULL shared_ptr
+       * and this record is unmodified.
        **/
       std::shared_ptr<std::string> take_string(const VariableReference & key,
              const KnowledgeReferenceSettings & settings =
@@ -274,7 +276,7 @@ namespace madara
       }
 
       /**
-       * Returns a shared_ptr, sharing with the internal one.
+       * @return a shared_ptr, sharing with the internal one.
        * If this record is not an integer array, returns NULL shared_ptr
        **/
       std::shared_ptr<std::vector<KnowledgeRecord::Integer>>
@@ -295,7 +297,7 @@ namespace madara
       }
 
       /**
-       * Returns a shared_ptr, sharing with the internal one.
+       * @return a shared_ptr, sharing with the internal one.
        * If this record is not an integer array, returns NULL shared_ptr
        **/
       std::shared_ptr<std::vector<KnowledgeRecord::Integer>>
@@ -316,8 +318,9 @@ namespace madara
       }
 
       /**
-       * Returns a shared_ptr, sharing with the internal one.
+       * @return a shared_ptr, sharing with the internal one.
        * If this record is not an integer array, returns NULL shared_ptr
+       * and this record is unmodified.
        **/
       std::shared_ptr<std::vector<KnowledgeRecord::Integer>>
         take_integers(const std::string & key,
@@ -337,8 +340,9 @@ namespace madara
       }
 
       /**
-       * Returns a shared_ptr, sharing with the internal one.
+       * @return a shared_ptr, sharing with the internal one.
        * If this record is not an integer array, returns NULL shared_ptr
+       * and this record is unmodified.
        **/
       std::shared_ptr<std::vector<KnowledgeRecord::Integer>>
         take_integers(const VariableReference & key,
@@ -358,7 +362,7 @@ namespace madara
       }
 
       /**
-       * Returns a shared_ptr, sharing with the internal one.
+       * @return a shared_ptr, sharing with the internal one.
        * If this record is not a doubles array, returns NULL shared_ptr
        **/
       std::shared_ptr<std::vector<double>>
@@ -379,7 +383,7 @@ namespace madara
       }
 
       /**
-       * Returns a shared_ptr, sharing with the internal one.
+       * @return a shared_ptr, sharing with the internal one.
        * If this record is not a doubles array, returns NULL shared_ptr
        **/
       std::shared_ptr<std::vector<double>>
@@ -400,8 +404,9 @@ namespace madara
       }
 
       /**
-       * Returns a shared_ptr, sharing with the internal one.
+       * @return a shared_ptr, sharing with the internal one.
        * If this record is not a doubles array, returns NULL shared_ptr
+       * and this record is unmodified.
        **/
       std::shared_ptr<std::vector<double>>
         take_doubles(const std::string & key,
@@ -421,8 +426,9 @@ namespace madara
       }
 
       /**
-       * Returns a shared_ptr, sharing with the internal one.
+       * @return a shared_ptr, sharing with the internal one.
        * If this record is not a doubles array, returns NULL shared_ptr
+       * and this record is unmodified.
        **/
       std::shared_ptr<std::vector<double>>
         take_doubles(const VariableReference & key,
@@ -442,7 +448,7 @@ namespace madara
       }
 
       /**
-       * Returns a shared_ptr, sharing with the internal one.
+       * @return a shared_ptr, sharing with the internal one.
        * If this record is not a binary file, returns NULL shared_ptr
        **/
       std::shared_ptr<std::vector<unsigned char>>
@@ -463,7 +469,7 @@ namespace madara
       }
 
       /**
-       * Returns a shared_ptr, sharing with the internal one.
+       * @return a shared_ptr, sharing with the internal one.
        * If this record is not a binary file, returns NULL shared_ptr
        **/
       std::shared_ptr<std::vector<unsigned char>>
@@ -484,8 +490,9 @@ namespace madara
       }
 
       /**
-       * Returns a shared_ptr, sharing with the internal one.
+       * @return a shared_ptr, sharing with the internal one.
        * If this record is not a binary file, returns NULL shared_ptr
+       * and this record is unmodified.
        **/
       std::shared_ptr<std::vector<unsigned char>>
         take_binary(const std::string & key,
@@ -505,8 +512,9 @@ namespace madara
       }
 
       /**
-       * Returns a shared_ptr, sharing with the internal one.
+       * @return a shared_ptr, sharing with the internal one.
        * If this record is not a binary file, returns NULL shared_ptr
+       * and this record is unmodified.
        **/
       std::shared_ptr<std::vector<unsigned char>>
         take_binary(const VariableReference & key,
@@ -1231,7 +1239,7 @@ namespace madara
       std::string setup_unique_hostport (const std::string & host = "");
 
       /**
-       * Returns a non-const reference to the Transport Settings
+       * @return a non-const reference to the Transport Settings
        * @return  settings reference
        **/
       madara::transport::TransportSettings & transport_settings (void);