Changeset 1063 for library/bdm/base/user_info.h

Timestamp:

06/09/10 11:50:16 (14 years ago)

Author:

mido

Message:

a small patch of documentation, to be contiuned..

Files:

• library/bdm/base/user_info.h (modified) (6 diffs)

library/bdm/base/user_info.h

@@ -395 +395 @@
         //! The new instance of type T* is constructed and initialized with values stored in the Setting element[name]
         //!
-        //! If there does not exist any sub-element named #name and settingPresence is #optional, an empty bdm::shared_ptr<T> is returned. When settingPresence is #compulsory, the returned bdm::shared_ptr<T> is never empty (an exception is thrown when the object isn't found).
+        //! If there does not exist any sub-element named name and settingPresence is optional, an empty bdm::shared_ptr<T> is returned. 
+        //! When settingPresence is compulsory, the returned bdm::shared_ptr<T> is never empty (an exception is thrown when the object isn't found).
         template<class T>
         static bdm::shared_ptr<T> build ( const Setting &element, const string &name, SettingPresence settingPresence = optional ) {
@@ -412 +413 @@
         //! The new instance of type T* is constructed and initialized with values stored in the Setting element[index]
         //!
-        //! If there does not exist  any sub-element indexed by #index, and settingPresence is #optional, an empty bdm::shared_ptr<T> is returned. When settingPresence is #compulsory, the returned bdm::shared_ptr<T> is never empty (an exception is thrown when the object isn't found).
+        //! If there does not exist  any sub-element indexed by index, and settingPresence is optional, an empty bdm::shared_ptr<T> is returned. 
+        //! When settingPresence is compulsory, the returned bdm::shared_ptr<T> is never empty (an exception is thrown when the object isn't found).
         template<class T>
         static bdm::shared_ptr<T> build ( const Setting &element, const int index, SettingPresence settingPresence = optional ) {
@@ -447 +449 @@
 
         //! The existing instance of type T is initialized with values stored in the Setting element[name]
-        //! If there does not exist any sub-element named #name, this method returns false.
+        //! If there does not exist any sub-element named name, this method returns false.
         template<class T> static bool get ( T &instance, const Setting &element, const string &name, SettingPresence settingPresence = optional ) {
                 if ( !element.exists ( name ) ) {
@@ -461 +463 @@
 
         //! The existing instance of type T is initialized with values stored in the Setting element[index]
-        //! If there does not exist any sub-element indexed by #index, this method returns false.
+        //! If there does not exist any sub-element indexed by index, this method returns false.
         template<class T> static bool get ( T &instance, const Setting &element, const int index, SettingPresence settingPresence = optional ) {
                 if ( element.getLength() <= index ) {
@@ -490 +492 @@
 
         //! The existing array of type T is initialized with values stored in the Setting element[name]
-        //! If there is not any sub-element named #name, this method returns false.
+        //! If there is not any sub-element named name, this method returns false.
         template<class T> static bool get ( Array<T> &array_to_load, const Setting &element, const string &name, SettingPresence settingPresence = optional ) {
                 if ( !element.exists ( name ) ) {
@@ -504 +506 @@
 
         //! The existing array of type T is initialized with values stored in the Setting element[index]
-        //! If there is not any sub-element indexed by #index, this method returns false.
+        //! If there is not any sub-element indexed by index, this method returns false.
         template<class T> static bool get ( Array<T> &array_to_load, const Setting &element, const int index, SettingPresence settingPresence = optional ) {
                 if ( element.getLength() <= index ) {