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 684193 - gtk-doc doclet: Use property documentation for getters and setters?
gtk-doc doclet: Use property documentation for getters and setters?
Status: RESOLVED OBSOLETE
Product: valadoc
Classification: Other
Component: doclet/html
git master
Other Linux
: Normal normal
: ---
Assigned To: valadoc-maint
valadoc-maint
Depends on:
Blocks:
 
 
Reported: 2012-09-17 09:37 UTC by Murray Cumming
Modified: 2021-06-10 20:55 UTC
See Also:
GNOME target: ---
GNOME version: ---


Description Murray Cumming 2012-09-17 09:37:48 UTC 
The html generated by valadoc's gtkdoc doclet does not seem to show properties
that are declared in the .vala file.

It does show the getter and setter functions that are generated for the properties, but they don't have the property documentation either.

I checked that the property documenation shows up in the regular valadoc html output, to check that I was using the right syntax.
Comment 1 Murray Cumming 2012-09-17 11:25:51 UTC 
If I pass the generated library file to valadoc then the properties do show up, along with signals and object hieriarchy.

However, it would be nice if the getters and setters used the same documentation, instead of just linking to the property documentation via the parameter/returns documentation.
Comment 2 André Klapper 2021-06-10 20:55:39 UTC 
GNOME is going to shut down bugzilla.gnome.org in favor of gitlab.gnome.org.
As part of that, we are mass-closing older open tickets in bugzilla.gnome.org
which have not seen updates for a longer time (resources are unfortunately
quite limited so not every ticket can get handled).

If you can still reproduce the situation described in this ticket in a recent
and supported software version of valadoc, then please follow
  https://wiki.gnome.org/GettingInTouch/BugReportingGuidelines
and create a new ticket at
  https://gitlab.gnome.org/GNOME/valadoc/-/issues/

Thank you for your understanding and your help.