diff options
| author | Kjell Ahlstedt <kjell.ahlstedt@bredband.net> | 2013-01-27 11:05:34 +0100 |
|---|---|---|
| committer | Kjell Ahlstedt <kjell.ahlstedt@bredband.net> | 2013-01-27 11:05:34 +0100 |
| commit | 0759fe84d17590eba58689f8d416b626b9b36b9c (patch) | |
| tree | c65c41f3ba3a081f839acbc50dbf7d121ac1d38f /gio/src/charsetconverter.hg | |
| parent | d1ccc3bae88396f03e5889286db50547a45dbfed (diff) | |
| download | glibmm-0759fe84d17590eba58689f8d416b626b9b36b9c.tar.gz | |
Documentation: Fix many warnings from Doxygen.
* gio/src/gio_docs_override.xml:
* glib/src/glib_docs_override.xml: Move "Since: n.m" from the <return> to the
<description> entries. gmmproc adds a period at the end of the @return
Doxygen command, and Doxygen warns for "@newin{n,m}.".
* glib/glibmm/interface.h:
* glib/glibmm/stringutils.h:
* glib/glibmm/vectorutils.h:
* gio/src/*.hg:
* glib/src/*.hg: (Here "*" means "many", not "all") Examples of changes:
Add missing @param. Change names of parameters, to make them equal in
function declaration and @param command. Change "@name" to "@a name".
Change "<ulink url=" to "<a href=".
Diffstat (limited to 'gio/src/charsetconverter.hg')
| -rw-r--r-- | gio/src/charsetconverter.hg | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/gio/src/charsetconverter.hg b/gio/src/charsetconverter.hg index 331b9aa1..b4808c85 100644 --- a/gio/src/charsetconverter.hg +++ b/gio/src/charsetconverter.hg @@ -40,7 +40,13 @@ protected: _IGNORE(g_charset_converter_new) public: - _WRAP_METHOD_DOCS_ONLY(g_charset_converter_new) + /** Creates a new CharsetConverter. + * + * @newin{2,24} + * @param to_charset Destination charset. + * @param from_charset Source charset. + * @return A new CharsetConverter, or <tt>0</tt> on error. + */ _WRAP_CREATE(const Glib::ustring& to_charset, const Glib::ustring& from_charset) _WRAP_METHOD(void set_use_fallback(bool use_fallback), g_charset_converter_set_use_fallback) |