]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/msw/ole/automtn.h
Initial review of various [q-r] by Utensil Candel.
[wxWidgets.git] / interface / msw / ole / automtn.h
index 20fefcc8380900e85580fe16e1ec90323a09f522..982efbe01a8fb60aa3f1bbfdf6d70632f8f8688e 100644 (file)
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        msw/ole/automtn.h
-// Purpose:     documentation for wxAutomationObject class
+// Purpose:     interface of wxAutomationObject
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 
     Note that this class obviously works under Windows only.
 
+    @onlyfor{wxmsw}
+
     @library{wxcore}
     @category{misc}
 
-    @seealso
-    wxVariant
+    @see wxVariant
 */
 class wxAutomationObject : public wxObject
 {
@@ -63,7 +64,7 @@ public:
         data types, and C++ provides temporary objects automatically, both of the
         following lines
         are syntactically valid:
-        
+
         Note that @a method can contain dot-separated property names, to save the
         application
         needing to call GetProperty several times using several temporary objects. For
@@ -107,7 +108,7 @@ public:
         from other objects.
         Note that an IDispatch pointer is stored as a void* pointer in wxVariant
         objects.
-        
+
         @see GetProperty()
     */
     bool GetObject(wxAutomationObject& obj, const wxString& property,
@@ -125,7 +126,7 @@ public:
         data types, and C++ provides temporary objects automatically, both of the
         following lines
         are syntactically valid:
-        
+
         Note that @a property can contain dot-separated property names, to save the
         application
         needing to call GetProperty several times using several temporary objects.
@@ -140,7 +141,7 @@ public:
         Invoke function.
         It is not meant to be called directly by the application, but is used by other
         convenience functions.
-        
+
         @param member
             The member function or property name.
         @param action
@@ -154,9 +155,9 @@ public:
             If non-null, contains an array of variants.
         @param ptrArgs
             If non-null, contains an array of constant pointers to variants.
-        
+
         @returns @true if the operation was successful, @false otherwise.
-        
+
         @remarks Two types of argument array are provided, so that when possible
                  pointers are used for efficiency.
     */
@@ -176,7 +177,7 @@ public:
         data types, and C++ provides temporary objects automatically, both of the
         following lines
         are syntactically valid:
-        
+
         Note that @a property can contain dot-separated property names, to save the
         application
         needing to call GetProperty several times using several temporary objects.
@@ -193,3 +194,4 @@ public:
     */
     void SetDispatchPtr(WXIDISPATCH* dispatchPtr);
 };
+