Overhaul the wxWebView documentation. Split the documentation into sections and add...

[wxWidgets.git] / interface / wx / iconbndl.h

diff --git a/interface/wx/iconbndl.h b/interface/wx/iconbndl.h
index aecfe287f5976907922ad7b42659d9fdeb1890bf..e242d695c46d67aecfb340fb2f437ece5d5202d7 100644 (file)
--- a/interface/wx/iconbndl.h
+++ b/interface/wx/iconbndl.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxIconBundle
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 /**
@@ -34,6 +34,10 @@ public:
     /**
         Initializes the bundle with the icon(s) found in the stream.
 
+        Notice that the @a stream must be seekable, at least if it contains
+        more than one icon. The stream pointer is positioned after the last
+        icon read from the stream when this function returns.
+
         @since 2.9.0
     */
     wxIconBundle(wxInputStream& stream, wxBitmapType type = wxBITMAP_TYPE_ANY);
@@ -65,6 +69,10 @@ public:
         collection already contains icons with the same width and height, they
         are replaced by the new ones.
 
+        Notice that, as well as in the constructor loading the icon bundle from
+        stream, the @a stream must be seekable, at least if more than one icon
+        is to be loaded from it.
+
         @since 2.9.0
     */
     void AddIcon(wxInputStream& stream, wxBitmapType type = wxBITMAP_TYPE_ANY);