more utils.h fixes

[wxWidgets.git] / interface / weakref.h

diff --git a/interface/weakref.h b/interface/weakref.h
index 96eabd5d235289f70f836f9b713a32533b95ccca..c72bd896e46b762f1a6c5c5312614ecb42be8343 100644 (file)
--- a/interface/weakref.h
+++ b/interface/weakref.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        weakref.h
-// Purpose:     documentation for wxWeakRefDynamic<T> class
+// Purpose:     interface of wxWeakRefDynamic<T>
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -9,65 +9,65 @@
 /**
     @class wxWeakRefDynamicT
     @wxheader{weakref.h}
-    
-    wxWeakRefDynamicT is a template class for weak references that is used in 
-    the same way as wxWeakRefT. The only difference is that wxWeakRefDynamic 
-    defaults to using @c dynamic_cast for establishing the object 
-    reference (while wxWeakRef defaults to @c static_cast). 
-    
+
+    wxWeakRefDynamicT is a template class for weak references that is used in
+    the same way as wxWeakRefT. The only difference is that wxWeakRefDynamic
+    defaults to using @c dynamic_cast for establishing the object
+    reference (while wxWeakRef defaults to @c static_cast).
+
     So, wxWeakRef will detect a type mismatch during compile time and will
     have a little better run-time performance. The role of wxWeakRefDynamic
-    is to handle objects which derived type one does not know. 
-    
-    @b Note: wxWeakRefT selects an implementation based on the static type 
+    is to handle objects which derived type one does not know.
+
+    @b Note: wxWeakRefT selects an implementation based on the static type
     of T. If T does not have wxTrackable statically, it defaults to to a mixed-
-    mode operation, where it uses @c dynamic_cast as the last measure (if 
-    available from the compiler and enabled when building wxWidgets). 
-    
-    For general cases, wxWeakRefT is the better choice. 
-    
+    mode operation, where it uses @c dynamic_cast as the last measure (if
+    available from the compiler and enabled when building wxWidgets).
+
+    For general cases, wxWeakRefT is the better choice.
+
     For API documentation, see: wxWeakRef
-    
+
     @library{wxcore}
     @category{FIXME}
 */
-class wxWeakRefDynamic<T> 
+class wxWeakRefDynamic<T>
 {
 public:
-    
+
 };
 
 
+
 /**
     @class wxWeakRefT
     @wxheader{weakref.h}
-    
-    wxWeakRef is a template class for weak references to wxWidgets objects, 
-    such as wxEvtHandler, wxWindow and 
+
+    wxWeakRef is a template class for weak references to wxWidgets objects,
+    such as wxEvtHandler, wxWindow and
     wxObject. A weak reference behaves much like an ordinary
     pointer, but when the object pointed is destroyed, the weak reference is
-    automatically reset to a @NULL pointer. 
-    
-    wxWeakRefT can be used whenever one must keep a pointer to an object 
+    automatically reset to a @NULL pointer.
+
+    wxWeakRefT can be used whenever one must keep a pointer to an object
     that one does not directly own, and that may be destroyed before the object
-    holding the reference. 
-    
-    wxWeakRefT is a small object and the mechanism behind it is fast 
-    (@b O(1)). So the overall cost of using it is small. 
-    
+    holding the reference.
+
+    wxWeakRefT is a small object and the mechanism behind it is fast
+    (@b O(1)). So the overall cost of using it is small.
+
     @library{wxbase}
     @category{FIXME}
-    
-    @seealso
-    wxSharedPtr, wxScopedPtr
+
+    @see wxSharedPtr, wxScopedPtr
 */
-class wxWeakRef<T> 
+class wxWeakRef<T>
 {
 public:
     /**
         Constructor. The weak reference is initialized to @e pobj.
     */
-    wxWeakRefT(T* pobj = @NULL);
+    wxWeakRefT(T* pobj = NULL);
 
     /**
         Destructor.
@@ -88,7 +88,7 @@ public:
     /**
         Returns pointer to the tracked object or @NULL.
     */
-    T * get();
+    T* get() const;
 
     /**
         Release currently tracked object and start tracking the same object as
@@ -100,13 +100,13 @@ public:
         Implicit conversion to T*. Returns pointer to the tracked
         object or @NULL.
     */
-    T* operator*();
+    T* operator*() const;
 
     /**
         Returns a reference to the tracked object. If the internal pointer is @NULL
         this method will cause an assert in debug mode.
     */
-    T operator*();
+    T operator*() const;
 
     /**
         Smart pointer member access. Returns a pointer to the
@@ -121,3 +121,4 @@ public:
     */
     T* operator=(T* pobj);
 };
+