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 74016 - make gtk-doc use nicks and blurbs to document properties
make gtk-doc use nicks and blurbs to document properties
Status: RESOLVED FIXED
Product: gtk-doc
Classification: Platform
Component: general
unspecified
Other other
: Normal normal
: ---
Assigned To: gtk-doc maintainers
gtk-doc maintainers
Depends on:
Blocks:
 
 
Reported: 2002-03-08 21:28 UTC by Matthias Clasen
Modified: 2004-12-22 21:47 UTC
See Also:
GNOME target: ---
GNOME version: ---

Attachments
the patch (3.68 KB, patch)
2002-03-08 21:29 UTC, Matthias Clasen 		none Details | Review
improved patch (3.70 KB, patch)
2002-03-11 20:43 UTC, Matthias Clasen 		none Details | Review

Description Matthias Clasen 2002-03-08 21:28:48 UTC 
Here is a patch to make gtk-doc emit nicks and blubs in the .args file
and use the blurbs to generate docs.
Comment 1 Matthias Clasen 2002-03-08 21:29:25 UTC 
Created attachment 7058 [details] [review]
the patch
Comment 2 Matthias Clasen 2002-03-08 21:31:19 UTC 
Using the patched gtk-doc on gtk leads to some redundancy, since
currently a number of properties have extra docs in the templates.
If the patch gets merged, I'd volunteer to quickly reduce the 
redundancy by moving all property docs from the templates to blurbs.
Comment 3 Damon Chaplin 2002-03-10 03:02:07 UTC 
Yes, it seems reasonable to use those in the docs.

Should you call CreateValidSGML() on the nicks/blurbs to convert
and '<' to '&lt;' etc.?
Comment 4 Matthias Clasen 2002-03-11 08:46:44 UTC 
I guess so, will produce a new patch shortly. Another thing to
take care of is ensuring that we extract the nicks/blurbs using
C locale, since I think they're translated. Otherwise we may end
up with German blurbs in an otherwise English manual.
Comment 5 Matthias Clasen 2002-03-11 20:43:32 UTC 
Created attachment 7107 [details] [review]
improved patch
Comment 6 Matthias Clasen 2002-04-03 11:13:15 UTC 
Whats up with this, Damon ?

Ok to commit ? I would like to revisit property documentation
when this patch is in.
Comment 7 Owen Taylor 2002-04-22 20:05:01 UTC 
Reassigning all open gtk-doc bugs to gtk-doc-maint
Comment 8 Matthias Clasen 2002-04-30 23:46:26 UTC 
This has been committed now (by accident). I have extended it to
also output child properties and to warn about properties without
blurbs. (see http://bugzilla.gnome.org/show_bug.cgi?id=57143)