warn that a seekable stream is required for generic implementation of wxAnimation

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@58083 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/interface/wx/animate.h b/interface/wx/animate.h
index 6e5f043905f3fe9c203cef38fa8b8911785b0b7b..967055b7bf7d2b5b325475de8a61edb4d08da4e7 100644 (file)
--- a/interface/wx/animate.h
+++ b/interface/wx/animate.h
@@ -203,7 +203,7 @@ public:
         @param name
             The name of the file to load.
         @param type
         @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);
     */
     wxAnimation(const wxString& name,
                 wxAnimationType type = wxANIMATION_TYPE_ANY);


@@ -245,11 +245,10 @@ public:
 
         @param stream
             The stream to use to load the animation.
 
         @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
         @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.
     */
 
         @return @true if the operation succeeded, @false otherwise.
     */


@@ -262,7 +261,7 @@ public:
         @param name
             A filename.
         @param type
         @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.
             means that the function should try to autodetect the filetype.
 
         @return @true if the operation succeeded, @false otherwise.