Added the function and macro group pages for Doxygen.

[wxWidgets.git] / interface / clipbrd.h

diff --git a/interface/clipbrd.h b/interface/clipbrd.h
index 1bb835a2e99bcf301027213c1ac17a9fa01d80cc..77e6dac9322124ceaa23b6a4570946a4e5b5110b 100644 (file)
--- a/interface/clipbrd.h
+++ b/interface/clipbrd.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        clipbrd.h
-// Purpose:     documentation for wxClipboard class
+// Purpose:     interface of wxClipboard
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -9,18 +9,17 @@
 /**
     @class wxClipboard
     @wxheader{clipbrd.h}
-    
+
     A class for manipulating the clipboard. Note that this is not compatible with
     the
     clipboard class from wxWidgets 1.xx, which has the same name but a different
     implementation.
-    
+
     To use the clipboard, you call member functions of the global @b wxTheClipboard
     object.
-    
-    See also the @ref overview_wxdataobjectoverview "wxDataObject overview" for
-    further information.
-    
+
+    See also the @ref overview_wxdataobjectoverview for further information.
+
     Call wxClipboard::Open to get ownership of the clipboard. If this operation
     returns @true, you
     now own the clipboard. Call wxClipboard::SetData to put data
@@ -28,19 +27,19 @@
     retrieve data from the clipboard. Call wxClipboard::Close to close
     the clipboard and relinquish ownership. You should keep the clipboard open only
     momentarily.
-    
+
     For example:
-    
+
     @code
     // Write some text to the clipboard
       if (wxTheClipboard-Open())
       {
-        // This data objects are held by the clipboard, 
+        // This data objects are held by the clipboard,
         // so do not delete them in the app.
         wxTheClipboard-SetData( new wxTextDataObject("Some text") );
         wxTheClipboard-Close();
       }
-    
+
       // Read some text
       if (wxTheClipboard-Open())
       {
@@ -49,16 +48,15 @@
           wxTextDataObject data;
           wxTheClipboard-GetData( data );
           wxMessageBox( data.GetText() );
-        }  
+        }
         wxTheClipboard-Close();
       }
     @endcode
-    
+
     @library{wxcore}
     @category{dnd}
-    
-    @seealso
-    @ref overview_wxdndoverview "Drag and drop overview", wxDataObject
+
+    @see @ref overview_wxdndoverview, wxDataObject
 */
 class wxClipboard : public wxObject
 {
@@ -76,12 +74,11 @@ public:
     /**
         Call this function to add the data object to the clipboard. You may call
         this function repeatedly after having cleared the clipboard using Clear().
-        
         After this function has been called, the clipboard owns the data, so do not
         delete
         the data explicitly.
         
-        @sa SetData()
+        @see SetData()
     */
     bool AddData(wxDataObject* data);
 
@@ -104,7 +101,7 @@ public:
     bool Flush();
 
     /**
-        Call this function to fill @e data with data on the clipboard, if available in
+        Call this function to fill @a data with data on the clipboard, if available in
         the required
         format. Returns @true on success.
     */
@@ -113,7 +110,7 @@ public:
     /**
         Returns @true if the clipboard has been opened.
     */
-    bool IsOpened();
+    bool IsOpened() const;
 
     /**
         Returns @true if there is data which matches the data format of the given data
@@ -126,15 +123,13 @@ public:
         one.
         See @ref useprimary() UsePrimarySelection for more information.
     */
-    bool IsUsingPrimarySelection();
+    bool IsUsingPrimarySelection() const;
 
     /**
-        Call this function to open the clipboard before calling SetData() 
+        Call this function to open the clipboard before calling SetData()
         and GetData().
-        
         Call Close() when you have finished with the clipboard. You
         should keep the clipboard open for only a very short time.
-        
         Returns @true on success. This should be tested (as in the sample shown above).
     */
     bool Open();
@@ -143,12 +138,11 @@ public:
         Call this function to set the data object to the clipboard. This function will
         clear all previous contents in the clipboard, so calling it several times
         does not make any sense.
-        
         After this function has been called, the clipboard owns the data, so do not
         delete
         the data explicitly.
         
-        @sa AddData()
+        @see AddData()
     */
     bool SetData(wxDataObject* data);
 
@@ -157,7 +151,6 @@ public:
         CLIPBOARD X11 selection by default. When this function is called with @true
         argument, all subsequent clipboard operations will use PRIMARY selection until
         this function is called again with @false.
-        
         On the other platforms, there is no PRIMARY selection and so all clipboard
         operations will fail. This allows to implement the standard X11 handling of the
         clipboard which consists in copying data to the CLIPBOARD selection only when
@@ -166,5 +159,6 @@ public:
         automatically, without overwriting the normal clipboard contents with the
         currently selected text on the other platforms.
     */
-    void UsePrimarySelection(bool primary = @true);
+    void UsePrimarySelection(bool primary = true);
 };
+