X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7e59b88579c7a1e8b4da0827be75dc5d2a84ec73..b5fe7ca67bf3121959a0b5a59afd00c1708f2f03:/interface/wx/animate.h

diff --git a/interface/wx/animate.h b/interface/wx/animate.h
index 6e5f043905..4dc9dd7567 100644
--- a/interface/wx/animate.h
+++ b/interface/wx/animate.h
@@ -181,6 +181,12 @@ public:
     An animation is a sequence of frames of the same size.
     Sound is not supported by wxAnimation.
 
+    Note that on wxGTK wxAnimation is capable of loading the formats supported
+    by the internally-used @c gdk-pixbuf library (typically this means only
+    or @c wxANIMATION_TYPE_GIF).
+    On other platforms wxAnimation is always capable of loading both GIF and ANI
+    formats (i.e. both @c wxANIMATION_TYPE_GIF and @c wxANIMATION_TYPE_ANI).
+
     @library{wxadv}
     @category{gdi}
 
@@ -203,7 +209,7 @@ public:
         @param name
             The name of the file to load.
         @param type
-            See LoadFile for more info.
+            See LoadFile() for more info.
     */
     wxAnimation(const wxString& name,
                 wxAnimationType type = wxANIMATION_TYPE_ANY);
@@ -245,11 +251,10 @@ public:
 
         @param stream
             The stream to use to load the animation.
+            Under wxGTK may be any kind of stream; under other platforms
+            this must be a seekable stream.
         @param type
-            One of the following values:
-             @li wxANIMATION_TYPE_GIF: loads an animated GIF file;
-             @li wxANIMATION_TYPE_ANI: load an ANI file;
-             @li wxANIMATION_TYPE_ANY: tries to autodetect the filetype.
+            One of the ::wxAnimationType enumeration values.
 
         @return @true if the operation succeeded, @false otherwise.
     */
@@ -262,7 +267,7 @@ public:
         @param name
             A filename.
         @param type
-            One of the wxAnimationType values; wxANIMATION_TYPE_ANY
+            One of the ::wxAnimationType values; wxANIMATION_TYPE_ANY
             means that the function should try to autodetect the filetype.
 
         @return @true if the operation succeeded, @false otherwise.