Finish API documentation
@hadess
Submitted by Bastien Nocera Link to original bug (#573392)
Description
<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
Edited by Bastien Nocera