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 611954 - Migrate API docs from templates to source files (GtkActionGroup)
Migrate API docs from templates to source files (GtkActionGroup)
Status: RESOLVED FIXED
Product: gtk+
Classification: Platform
Component: Documentation
unspecified
Other Linux
: Normal normal
: ---
Assigned To: gtk-bugs
gtk-bugs
Depends on:
Blocks: 599599
 
 
Reported: 2010-03-05 23:12 UTC by Tadej Borovšak
Modified: 2010-07-12 17:56 UTC
See Also:
GNOME target: ---
GNOME version: ---

Attachments
Patch that migrates API docs. (15.43 KB, patch)
2010-03-05 23:12 UTC, Tadej Borovšak 		needs-work Details | Review
Patch that migrates API docs (updated). (16.53 KB, patch)
2010-07-03 21:27 UTC, Tadej Borovšak 		committed Details | Review

Description Tadej Borovšak 2010-03-05 23:12:17 UTC 
Created attachment 155382 [details] [review]
Patch that migrates API docs.

A patch to migrate docs is attached.
Comment 1 Javier Jardón (IRC: jjardon) 2010-03-06 15:32:28 UTC 
Review of attachment 155382 [details] [review]:

::: gtk/gtkactiongroup.c
@@ +46,3 @@
+ * @Short_description: A group of actions
+ * SECTION:gtkactiongroup
+/**

I've not checked it, but are you sure this generates the doc correctly? (I don't see the opening tag <para>)

@@ +73,3 @@
+ * </para>
+ * <example>
+ * <title>A <structname>#GtkDialog</structname> UI definition fragment.</title>

I think <structname> is not needed here

::: gtk/gtkactiongroup.h
@@ +92,3 @@
+ * @name: The name of the action.
+ * GtkActionEntry:
+/**

Use #GtkActionEntry instead <structname>GtkActionEntry</structname>

@@ +119,3 @@
+ * @name: The name of the action.
+ * GtkToggleActionEntry:
+/**

Same here

@@ +147,3 @@
+ * @name: The name of the action.
+ * GtkRadioActionEntry:
+/**

Same here
Comment 2 Tadej Borovšak 2010-07-03 21:27:40 UTC 
Created attachment 165195 [details] [review]
Patch that migrates API docs (updated).

Updated patch with recommendations and rebased it to git master.
Comment 3 Javier Jardón (IRC: jjardon) 2010-07-12 17:56:27 UTC 
Comment on attachment 165195 [details] [review]
Patch that migrates API docs (updated).

commit 75e75cd3050fd974e097ab4b7a801e59823fad85
Comment 4 Javier Jardón (IRC: jjardon) 2010-07-12 17:56:56 UTC 
This problem has been fixed in the development version. The fix will be available in the next major software release. Thank you for your bug report.