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 441326 - Add Gtk-Doc comment blocks to gobject class
Add Gtk-Doc comment blocks to gobject class
Status: RESOLVED OBSOLETE
Product: anjuta
Classification: Applications
Component: Plugins: class-gen
SVN TRUNK
Other All
: Normal enhancement
: ---
Assigned To: Armin Burgmeier
Anjuta maintainers
Depends on:
Blocks:
 
 
Reported: 2007-05-26 00:16 UTC by Étienne Bersac
Modified: 2020-11-07 12:12 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Preliminary docblock generation in class-gen (3.61 KB, patch)
2007-05-26 00:31 UTC, Étienne Bersac
needs-work Details | Review

Description Étienne Bersac 2007-05-26 00:16:33 UTC
Please describe the problem:
Hi,

Even if user activate gtk-doc at project creation, class-gen does not add gtk-doc block to section, properties, signals and public functions.

Steps to reproduce:
1. Create a project with gtk-doc enable
2. Create a GObject subclass using class-gen


Actual results:
No doc block.

Expected results:
Allmost all docblock for documented symbols.

Does this happen every time?
Yes

Other information:
I will provide a patch with preliminary implementation of this feature.

Anjuta rox !

Étienne.
Comment 1 Étienne Bersac 2007-05-26 00:31:29 UTC
Created attachment 88830 [details] [review]
Preliminary docblock generation in class-gen

Hi,

This patch add docblock for public instance struct field, section, properties, signals and public functions. I modifed window.c in order to compute gtk-doc section id from file (filename without suffixe .c or .h).

However, it bugs on listing public function arguments. Also it produce docblock even if gtk-doc is not enabled.

Regards,
Étienne.
Comment 2 Johannes Schmid 2007-06-13 21:05:51 UTC
Thanks for the patch and sorry that I missed it so long.

In general this is good but we should add a checkbutton to the class-gen wizard for gtk-doc on C Class and (when we support it) Doxygen for C++ clases.
Comment 3 Étienne Bersac 2007-06-14 09:35:12 UTC
I agree, my patch wasn't intended to be included as is, but as basic start for this feature.

Regards,
Étienne.
Comment 4 André Klapper 2020-11-07 12:12:32 UTC
bugzilla.gnome.org is being replaced by gitlab.gnome.org. We are closing all
old feature requests in Bugzilla which have not seen updates for many years.

If you are still requesting this feature in a currently supported version of GNOME (currently that would be 3.38), then please feel free to report it at https://gitlab.gnome.org/GNOME/anjuta/-/issues/

Thank you for reporting this issue and we are sorry it could not be implemented.