]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/animate.h
fix various Doxygen errors (#9568)
[wxWidgets.git] / interface / animate.h
index f840408f4378aef371af62e6d9359ca4f81f034b..c2f4735b3c37d2045adce909ceddb3b7e36da69b 100644 (file)
@@ -50,7 +50,7 @@ enum wxAnimationType
 
     @nativeimpl{wxgtk,wxmsw}
 
-    @appearance{animationctrl.png}
+    <!-- @appearance{animationctrl.png} -->
 
     @see wxAnimation
 */
@@ -90,8 +90,8 @@ public:
         @param name
             Control name.
 
-        @returns @true if the control was successfully created or @false if
-                 creation failed.
+        @return @true if the control was successfully created or @false if
+                creation failed.
     */
     bool Create(wxWindow* parent, wxWindowID id,
                 const wxAnimation& anim = wxNullAnimation,
@@ -123,6 +123,13 @@ public:
     virtual bool LoadFile(const wxString& file,
                           wxAnimationType animType = wxANIMATION_TYPE_ANY);
 
+    /**
+        Loads the animation from the given stream and calls SetAnimation().
+        See wxAnimation::Load() for more info.
+    */
+    virtual bool Load(wxInputStream& file,
+                      wxAnimationType animType = wxANIMATION_TYPE_ANY);
+
     /**
         Starts playing the animation.
 
@@ -246,7 +253,7 @@ public:
              @li wxANIMATION_TYPE_ANI: load an ANI file;
              @li wxANIMATION_TYPE_ANY: tries to autodetect the filetype.
 
-        @returns @true if the operation succeeded, @false otherwise.
+        @return @true if the operation succeeded, @false otherwise.
     */
     virtual bool Load(wxInputStream& stream,
                       wxAnimationType type = wxANIMATION_TYPE_ANY);
@@ -260,7 +267,7 @@ public:
             One of the wxAnimationType values; wxANIMATION_TYPE_ANY
             means that the function should try to autodetect the filetype.
 
-        @returns @true if the operation succeeded, @false otherwise.
+        @return @true if the operation succeeded, @false otherwise.
     */
     virtual bool LoadFile(const wxString& name,
                           wxAnimationType type = wxANIMATION_TYPE_ANY);