After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 106134 - Incorrect parsing of gtk_docs_override.xml
Incorrect parsing of gtk_docs_override.xml
Status: RESOLVED NOTABUG
Product: gtkmm
Classification: Bindings
Component: reference documentation
2.2
Other Linux
: Normal normal
: ---
Assigned To: gtkmm-forge
gtkmm-forge
Depends on:
Blocks:
 
 
Reported: 2003-02-15 00:07 UTC by Bryan Forbes
Modified: 2004-12-22 21:47 UTC
See Also:
GNOME target: ---
GNOME version: 2.1/2.2



Description Bryan Forbes 2003-02-15 00:07:00 UTC
I was adding some functions to the gtk_docs_override.xml and the parser
wouldn't parse this correctly:
<function name="gtk_adjustment_clamp_page">
<description>
Updates the Adjustment value to ensure that the range between the
parameters @lower and @upper is in the current page (i.e. between @value
and @value + @page_size).  If this range is larger than the page size, then
only the start of it will be in the current page.  A "changed" signal will
be emitted if the value is changed.
</description>
<parameters>
<parameter name="upper">
<parameter_description> The upper value.
</parameter_description>
</parameter>
<parameter name="lower">
<parameter_description> The lower value.
</parameter_description>
</parameter>
</parameters>
<return>
</return>
</function>

What it gave me was this:

   /** Updates the Adjustment value to ensure that the range between the
parameters @a lower  and @a upper  is in the current page (i.e.\ between @a
value  and @a value  + @a page_size ).  If this range is larger than the
page size, then only the start of it will be in the current page.  A
"changed" signal will be emitted if the value is changed.
   * @param lower The lower value.
   */
  void clamp_page(double lower, double upper);

It should have one more @param after the @param lower, according to the xml
Comment 1 Bryan Forbes 2003-02-15 18:36:08 UTC
My bad, that should say:
It should have one more @param BEFORE the @param lower, according to
the xml

sorry :)
Comment 2 Murray Cumming 2003-02-15 19:26:21 UTC
The first parameter is always ignored, because it's the GTK+ object
itself. For instance, the first parameter here should be a GtkAdjustment*.