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 573392 - Finish API documentation
Finish API documentation
Status: RESOLVED OBSOLETE
Product: gnome-bluetooth
Classification: Core
Component: general
unspecified
Other Linux
: Normal normal
: ---
Assigned To: gnome-bluetooth-general-maint@gnome.bugs
gnome-bluetooth-general-maint@gnome.bugs
: 642982 (view as bug list)
Depends on:
Blocks:
 
 
Reported: 2009-02-27 13:17 UTC by Bastien Nocera
Modified: 2019-03-20 10:35 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Bastien Nocera 2009-02-27 13:17:05 UTC
<ensonic> /**
<ensonic>   * BluetoothChooser:device-type-filter:
<ensonic>   *
<ensonic>   * FIXME
<ensonic>   **/
<ensonic>  g_object_class_install_property (G_OBJECT_CLASS(klass),
<ensonic>       PROP_DEVICE_TYPE_FILTER, g_param_spec_int ("device-type-filter", NULL, NULL,
<ensonic> one problem here is NULL, NULL in the param-spec
<ensonic> gtk-doc gets the docs from this
<ensonic> altough you can document thsi also manualy
<ensonic> /**
<ensonic>   * BluetoothChooser:device-type-filter:
<ensonic>   *
<ensonic>   * This property allows to ...
<ensonic>   *
<ensonic>   * Since: 0.10.2356
<ensonic>   */
<ensonic> gtk-doc understands that FIXME == "" :)
<ensonic> then at the top of each module (gobject) have a comment like this:
<ensonic>  * SECTION:BluetoothChooser
<ensonic>  * @short_description: pick bluetooth device
<ensonic>  *
<ensonic>  * This dialog lets you ...
<ensonic>  */
<ensonic> finally consider filling the [] section in docs/reference/.../gnome-bluetooth-docs.sgml
<ensonic> that should plum most holes
<ensonic> if you have a gtk-doc-1.11 you will get most warnings in gcc-style
Comment 1 Bastien Nocera 2011-06-29 15:07:28 UTC
*** Bug 642982 has been marked as a duplicate of this bug. ***
Comment 2 GNOME Infrastructure Team 2019-03-20 10:35:15 UTC
-- GitLab Migration Automatic Message --

This bug has been migrated to GNOME's GitLab instance and has been closed from further activity.

You can subscribe and participate further through the new bug through this link to our GitLab instance: https://gitlab.gnome.org/GNOME/gnome-bluetooth/issues/11.