fix various Doxygen errors (#9568)

[wxWidgets.git] / interface / animate.h

diff --git a/interface/animate.h b/interface/animate.h
index 861625aec3c4a16d6ded48581d556031416d8b6e..c2f4735b3c37d2045adce909ceddb3b7e36da69b 100644 (file)
--- a/interface/animate.h
+++ b/interface/animate.h
@@ -37,9 +37,9 @@ enum wxAnimationType
     It is only available if @c wxUSE_ANIMATIONCTRL is set to 1 (the default).
 
     @beginStyleTable
-    @style{wxAC_DEFAULT_STYLE}:
+    @style{wxAC_DEFAULT_STYLE}
            The default style: wxBORDER_NONE.
-    @style{wxAC_NO_AUTORESIZE}:
+    @style{wxAC_NO_AUTORESIZE}
            By default, the control will adjust its size to exactly fit to the
            size of the animation when SetAnimation is called. If this style
            flag is given, the control will not change its size
@@ -50,7 +50,7 @@ enum wxAnimationType
 
     @nativeimpl{wxgtk,wxmsw}
 
-    @appearance{animationctrl.png}
+    <!-- @appearance{animationctrl.png} -->
 
     @see wxAnimation
 */
@@ -66,7 +66,7 @@ public:
                     const wxPoint& pos = wxDefaultPosition,
                     const wxSize& size = wxDefaultSize,
                     long style = wxAC_DEFAULT_STYLE,
-                    const wxString& name = "animationctrl");
+                    const wxString& name = wxAnimationCtrlNameStr);
 
     /**
         Creates the control with the given @a anim animation.
@@ -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);