remove C++ comment

[wxWidgets.git] / docs / latex / wx / csconv.tex

diff --git a/docs/latex/wx/csconv.tex b/docs/latex/wx/csconv.tex
index 2d09197bf2a01e15d57535fdd3f38c243a002931..b26bef4ced19c822b26f6ff5d77eecd43330c3bc 100644 (file)
--- a/docs/latex/wx/csconv.tex
+++ b/docs/latex/wx/csconv.tex
@@ -17,6 +17,10 @@ default user character set.
 
 <wx/strconv.h>
 
+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+
 \wxheading{See also}
 
 \helpref{wxMBConv}{wxmbconv}, 
@@ -29,32 +33,43 @@ default user character set.
 
 \func{}{wxCSConv}{\param{const wxChar* }{charset}}
 
-Constructor. Specify the name of the character set you want to convert
-from/to.
+\func{}{wxCSConv}{\param{wxFontEncoding }{encoding}}
+
+Constructor. You may specify either the name of the character set you want to
+convert from/to or an encoding constant. If the character set name (or the
+encoding) is not recognized, ISO 8859-1 is used as fall back.
+
 
 \membersection{wxCSConv::\destruct{wxCSConv}}\label{wxcsconvdtor}
 
 \func{}{\destruct{wxCSConv}}{\void}
 
-Destructor.
+Destructor frees any resources needed to perform the conversion.
+
 
-\membersection{wxCSConv::LoadNow}\label{wxcsconvloadnow}
+\membersection{wxCSConv::IsOk}\label{wxcsconvisok}
 
-\func{void}{LoadNow}{\void}
+\constfunc{bool}{IsOk}{\void}
+
+Returns \true if the charset (or the encoding) given at constructor is really
+available to use. Returns \false if ISO 8859-1 will be used instead.
+
+Note this does \emph{not} mean that a given string will be correctly converted.
+A malformed string may still make conversion functions return \texttt{wxCONV\_FAILED}.
+
+\newsince{2.8.2}
 
-If the conversion tables needs to be loaded from disk, this method
-will do so. Otherwise, they will be loaded when any of the conversion
-methods are called.
 
 \membersection{wxCSConv::MB2WC}\label{wxcsconvmb2wc}
 
 \constfunc{size\_t}{MB2WC}{\param{wchar\_t* }{buf}, \param{const char* }{psz}, \param{size\_t }{n}}
 
-Converts from the selected character set to Unicode. Returns the size of the destination buffer.
+Converts from the selected character set to Unicode. Returns length of string written to destination buffer.
+
 
 \membersection{wxCSConv::WC2MB}\label{wxcsconvwc2mb}
 
 \constfunc{size\_t}{WC2MB}{\param{char* }{buf}, \param{const wchar\_t* }{psz}, \param{size\_t }{n}}
 
-Converts from Unicode to the selected character set. Returns the size of the destination buffer.
+Converts from Unicode to the selected character set. Returns length of string written to destination buffer.