clear up wxStringBuffer docs a bit

[wxWidgets.git] / include / wx / variant.h

diff --git a/include/wx/variant.h b/include/wx/variant.h
index 569793c5d3e16a3a08046860f36f303e2b4f4846..3d3ad32484754f65746414ec5ebadcfae46bcfb8 100644 (file)
--- a/include/wx/variant.h
+++ b/include/wx/variant.h
@@ -52,7 +52,7 @@ DECLARE_ABSTRACT_CLASS(wxVariantData)
 public:
 
 // Construction & destruction
 public:
 
 // Construction & destruction

-    wxVariantData() {};
+    wxVariantData() {}

 
 // Override these to provide common functionality
     // Copy to data
 
 // Override these to provide common functionality
     // Copy to data


@@ -98,9 +98,8 @@ public:
     wxVariant(const wxStringList& val, const wxString& name = wxEmptyString);
     wxVariant(const wxList& val, const wxString& name = wxEmptyString); // List of variants
     wxVariant(void* ptr, const wxString& name = wxEmptyString); // void* (general purpose)
     wxVariant(const wxStringList& val, const wxString& name = wxEmptyString);
     wxVariant(const wxList& val, const wxString& name = wxEmptyString); // List of variants
     wxVariant(void* ptr, const wxString& name = wxEmptyString); // void* (general purpose)

-    wxVariant(wxObject* ptr, const wxString& name = wxEmptyString); //wxObject 
+    wxVariant(wxObject* ptr, const wxString& name = wxEmptyString); //wxObject

     wxVariant(wxVariantData* data, const wxString& name = wxEmptyString); // User-defined data
     wxVariant(wxVariantData* data, const wxString& name = wxEmptyString); // User-defined data

-//TODO: Need to document

 #if wxUSE_DATETIME
     wxVariant(const wxDateTime& val, const wxString& name = wxEmptyString); // Date
 #endif // wxUSE_DATETIME
 #if wxUSE_DATETIME
     wxVariant(const wxDateTime& val, const wxString& name = wxEmptyString); // Date
 #endif // wxUSE_DATETIME


@@ -110,8 +109,7 @@ public:
     wxVariant(const TIME_STRUCT* valptr, const wxString& name = wxEmptyString); // DateTime
     wxVariant(const TIMESTAMP_STRUCT* valptr, const wxString& name = wxEmptyString); // DateTime
 #endif
     wxVariant(const TIME_STRUCT* valptr, const wxString& name = wxEmptyString); // DateTime
     wxVariant(const TIMESTAMP_STRUCT* valptr, const wxString& name = wxEmptyString); // DateTime
 #endif

-//TODO: End of Need to document
-    
+

     wxVariant(const wxVariant& variant);
     ~wxVariant();
 
     wxVariant(const wxVariant& variant);
     ~wxVariant();
 


@@ -119,7 +117,6 @@ public:
     // Assignment
     void operator= (const wxVariant& variant);
 
     // Assignment
     void operator= (const wxVariant& variant);
 

-//TODO: Need to document

 #if wxUSE_DATETIME
     bool operator== (const wxDateTime& value) const;
     bool operator!= (const wxDateTime& value) const;
 #if wxUSE_DATETIME
     bool operator== (const wxDateTime& value) const;
     bool operator!= (const wxDateTime& value) const;


@@ -134,7 +131,6 @@ public:
     void operator= (const TIME_STRUCT* value) ;
     void operator= (const TIMESTAMP_STRUCT* value) ;
 #endif
     void operator= (const TIME_STRUCT* value) ;
     void operator= (const TIMESTAMP_STRUCT* value) ;
 #endif

-//TODO: End of Need to document

 
     // Assignment using data, e.g.
     // myVariant = new wxStringVariantData("hello");
 
     // Assignment using data, e.g.
     // myVariant = new wxStringVariantData("hello");


@@ -188,11 +184,9 @@ public:
     // No implicit conversion to wxObject, as that would really
     //  confuse people between conversion to our contained data
     //  and downcasting to see our base type.
     // No implicit conversion to wxObject, as that would really
     //  confuse people between conversion to our contained data
     //  and downcasting to see our base type.

-//TODO: Need to document

 #if wxUSE_DATETIME
     inline operator wxDateTime () const { return GetDateTime(); }
 #endif // wxUSE_DATETIME
 #if wxUSE_DATETIME
     inline operator wxDateTime () const { return GetDateTime(); }
 #endif // wxUSE_DATETIME

-//TODO: End of Need to document

 
 // Accessors
     // Sets/gets name
 
 // Accessors
     // Sets/gets name


@@ -228,12 +222,10 @@ public:
 
     void* GetVoidPtr() const ;
     wxObject* GetWxObjectPtr()  ;
 
     void* GetVoidPtr() const ;
     wxObject* GetWxObjectPtr()  ;

-//TODO: Need to document

 #if wxUSE_DATETIME
     wxDateTime GetDateTime() const ;
 #endif // wxUSE_DATETIME
     wxArrayString GetArrayString() const;
 #if wxUSE_DATETIME
     wxDateTime GetDateTime() const ;
 #endif // wxUSE_DATETIME
     wxArrayString GetArrayString() const;

-//TODO: End of Need to document

 
 // Operations
     // Make NULL (i.e. delete the data)
 
 // Operations
     // Make NULL (i.e. delete the data)


@@ -248,7 +240,7 @@ public:
     // Insert at front of list
     void Insert(const wxVariant& value);
 
     // Insert at front of list
     void Insert(const wxVariant& value);
 

-    // Returns TRUE if the variant is a member of the list
+    // Returns true if the variant is a member of the list

     bool Member(const wxVariant& value) const;
 
     // Deletes the nth element of the list
     bool Member(const wxVariant& value) const;
 
     // Deletes the nth element of the list


@@ -265,11 +257,9 @@ public:
     bool Convert(double* value) const;
     bool Convert(wxString* value) const;
     bool Convert(char* value) const;
     bool Convert(double* value) const;
     bool Convert(wxString* value) const;
     bool Convert(char* value) const;

-//TODO: Need to document

 #if wxUSE_DATETIME
     bool Convert(wxDateTime* value) const;
 #endif // wxUSE_DATETIME
 #if wxUSE_DATETIME
     bool Convert(wxDateTime* value) const;
 #endif // wxUSE_DATETIME

-//TODO: End of Need to document

 
 // Attributes
 protected:
 
 // Attributes
 protected:


@@ -278,12 +268,12 @@ protected:
 };
 
 //Since we want type safety wxVariant we need to fetch and dynamic_cast
 };
 
 //Since we want type safety wxVariant we need to fetch and dynamic_cast

-//in a seemingly safe way so the compiler can check, so we define 
+//in a seemingly safe way so the compiler can check, so we define

 //a dynamic_cast /wxDynamicCast analogue.
 
 #define wxGetVariantCast(var,classname) \
 //a dynamic_cast /wxDynamicCast analogue.
 
 #define wxGetVariantCast(var,classname) \

-       ((classname*)(var.IsValueKindOf(&classname::sm_class##classname) ?\
-                     var.GetWxObjectPtr() : NULL));
+    ((classname*)(var.IsValueKindOf(&classname::ms_classInfo) ?\
+                  var.GetWxObjectPtr() : NULL));

 
 extern wxVariant WXDLLIMPEXP_BASE wxNullVariant;
 
 
 extern wxVariant WXDLLIMPEXP_BASE wxNullVariant;