Commit e4a65725 authored by Owen Taylor's avatar Owen Taylor Committed by Owen Taylor

Move docs inline, rewrite docs, mention memory management for the return

Tue Oct 28 09:21:29 2003  Owen Taylor  <otaylor@redhat.com>

        * gtk/gtkmain.c (gtk_check_version): Move docs inline,
        rewrite docs, mention memory management for the return
        value. (Partly addresses #125549, Michael Natterer)
parent dbd3b079
Tue Oct 28 09:21:29 2003 Owen Taylor <otaylor@redhat.com>
* gtk/gtkmain.c (gtk_check_version): Move docs inline,
rewrite docs, mention memory management for the return
value. (Partly addresses #125549, Michael Natterer)
2003-10-28 Padraig O'Briain <padraig.obriain@sun.com>
* gtk/gtkfilechooserdefault.c (gtk_file_chooser_default_remove_filter):
......
Tue Oct 28 09:21:29 2003 Owen Taylor <otaylor@redhat.com>
* gtk/gtkmain.c (gtk_check_version): Move docs inline,
rewrite docs, mention memory management for the return
value. (Partly addresses #125549, Michael Natterer)
2003-10-28 Padraig O'Briain <padraig.obriain@sun.com>
* gtk/gtkfilechooserdefault.c (gtk_file_chooser_default_remove_filter):
......
Tue Oct 28 09:21:29 2003 Owen Taylor <otaylor@redhat.com>
* gtk/gtkmain.c (gtk_check_version): Move docs inline,
rewrite docs, mention memory management for the return
value. (Partly addresses #125549, Michael Natterer)
2003-10-28 Padraig O'Briain <padraig.obriain@sun.com>
* gtk/gtkfilechooserdefault.c (gtk_file_chooser_default_remove_filter):
......
Tue Oct 28 09:21:29 2003 Owen Taylor <otaylor@redhat.com>
* gtk/gtkmain.c (gtk_check_version): Move docs inline,
rewrite docs, mention memory management for the return
value. (Partly addresses #125549, Michael Natterer)
2003-10-28 Padraig O'Briain <padraig.obriain@sun.com>
* gtk/gtkfilechooserdefault.c (gtk_file_chooser_default_remove_filter):
......
Tue Oct 28 09:21:29 2003 Owen Taylor <otaylor@redhat.com>
* gtk/gtkmain.c (gtk_check_version): Move docs inline,
rewrite docs, mention memory management for the return
value. (Partly addresses #125549, Michael Natterer)
2003-10-28 Padraig O'Briain <padraig.obriain@sun.com>
* gtk/gtkfilechooserdefault.c (gtk_file_chooser_default_remove_filter):
......
......@@ -76,21 +76,12 @@ about it. ;-)
<!-- ##### FUNCTION gtk_check_version ##### -->
<para>
Checks that the GTK+ library in use is equal to the given
version. Primarily useful to compare the header file version
(from #GTK_MAJOR_VERSION, #GTK_MINOR_VERSION, #GTK_MICRO_VERSION)
the the runtime library version. This should only be done
in the build for your application, to check that the user's libraries
and header files are the same. Applications should not do this
when deployed, because it's OK for applications to use a different
micro version of GTK+ than the one they were compiled against.
</para>
@required_major: the required major version.
@required_minor: the required major version.
@required_micro: the required major version.
@Returns: %NULL if the GTK+ library is compatible with the given version, or
a string describing the version mismatch.
</para>
@required_major:
@required_minor:
@required_micro:
@Returns:
<!-- ##### MACRO GTK_MAJOR_VERSION ##### -->
......
......@@ -172,6 +172,40 @@ static const guint gtk_ndebug_keys = sizeof (gtk_debug_keys) / sizeof (GDebugKey
#endif /* G_ENABLE_DEBUG */
/**
* gtk_check_version:
* @required_major: the required major version.
* @required_minor: the required major version.
* @required_micro: the required major version.
*
* Checks that the GTK+ library in use is compatible with the
* given version. Generally you would pass in the constants
* #GTK_MAJOR_VERSION, #GTK_MINOR_VERSION, #GTK_MICRO_VERSION
* as the three arguments to this function; that produces
* a check that the library in use is compatible with
* the version of GTK+ the application or module was compiled
* against.
*
* Compatibility is defined by two things: first the version
* of the running library is newer than the version
* @required_major.required_minor.@required_micro. Second
* the running library must be binary compatible with the
* version @required_major.required_minor.@required_micro
* (same major version.)
*
* This function is primarily for GTK+ modules; the module
* can call this function to check that it wasn't loaded
* into an incompatible version of GTK+. However, such a
* a check isn't completely reliable, since the module may be
* linked against an old version of GTK+ and calling the
* old version of gtk_check_version(), but still get loaded
* into an application using a newer version of GTK+.
*
* Return value: %NULL if the GTK+ library is compatible with the
* given version, or a string describing the version mismatch.
* The returned string is owned by GTK+ and should not be modified
* or freed.
**/
gchar*
gtk_check_version (guint required_major,
guint required_minor,
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment