From: Vadim Zeitlin <vadim@wxwidgets.org>
Date: Mon, 9 Apr 2007 00:19:13 +0000 (+0000)
Subject: added missing membersection for CreateIconBundle
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/bafddbe8829ed0a02a3a7502351dce3698caa7fe

added missing membersection for CreateIconBundle


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

diff --git a/docs/latex/wx/artprov.tex b/docs/latex/wx/artprov.tex
index 264f579b7e..cb6692cac9 100644
--- a/docs/latex/wx/artprov.tex
+++ b/docs/latex/wx/artprov.tex
@@ -168,10 +168,10 @@ by \helpref{GetBitmap}{wxartprovidergetbitmap}.
 
 \func{wxBitmap}{CreateBitmap}{\param{const wxArtID\& }{id}, \param{const wxArtClient\& }{client}, \param{const wxSize\& }{size}}
 
-Derived art provider classes must override this method or the CreateIconBundle() method
-to create requested art resource. Note that returned bitmaps are cached by wxArtProvider
-and it is therefore not necessary to optimize CreateBitmap() for speed (e.g. you may create
-wxBitmap objects from XPMs here).
+Derived art provider classes must override this method to create requested art
+resource. Note that returned bitmaps are cached by wxArtProvider and it is
+therefore not necessary to optimize CreateBitmap() for speed (e.g. you may
+create wxBitmap objects from XPMs here).
 
 \wxheading{Parameters}
 
@@ -191,28 +191,19 @@ This is {\bf not} part of wxArtProvider's public API, use
 \helpref{wxArtProvider::GetIcon}{wxartprovidergeticon}
 to query wxArtProvider for a resource.
 
+\wxheading{See also}
 
-\func{wxIconBundle}{CreateIconBundle}{\param{const wxArtID\& }{id}, \param{const wxArtClient\& }{client}}
+\helpref{CreateIconBundle}{wxartprovidercreateiconbundle}
 
-Derived art provider classes must override this method or the CreateIconBundle method
-to create requested art resource. Note that returned icon bundles are cached by wxArtProvider
-and it is therefore not necessary to optimize CreateIconBundle for speed (e.g. you may create icon bundles
-from artwork resources here).
 
-\wxheading{Parameters}
+\membersection{wxArtProvider::CreateIconBundle}\label{wxartprovidercreateiconbundle}
 
-\docparam{id}{wxArtID unique identifier of the icon bundle.}
+\func{wxIconBundle}{CreateIconBundle}{\param{const wxArtID\& }{id}, \param{const wxArtClient\& }{client}}
 
-\docparam{client}{wxArtClient identifier of the client (i.e. who is asking for the icon bundle).
-This only servers as a hint.}
+This method is similar to \helpref{CreateBitmap}{wxartprovidercreatebitmap} but
+can be used when a bitmap (or an icon) exists in several sizes.
 
-\wxheading{Note}
 
-This is {\bf not} part of wxArtProvider's public API, use
-\helpref{wxArtProvider::GetBitmap}{wxartprovidergetbitmap} or 
-\helpref{wxArtProvider::GetIconBundle}{wxartprovidergeticonbundle} or
-\helpref{wxArtProvider::GetIcon}{wxartprovidergeticon}
-to query wxArtProvider for a resource.
 
 \membersection{wxArtProvider::Delete}\label{wxartproviderdelete}