GNOME Bugzilla – Bug 615136
doc extraction scripts could support GObjectIntrospection annotations
Last modified: 2010-04-12 02:13:31 UTC
Created attachment 158165 [details] [review] Patch extending doc extraction scripts With the new gir annotations, sometimes the annotations are included in the generated docs xml. The attached patch modifies the doc extraction scripts to deal with the new annotations[1]. [1] http://live.gnome.org/GObjectIntrospection/Annotations The patch also enhances the documentation generation by modularizing the code and tweaking the regular expressions to handle special cases so that, for example, the function descriptions are not replaced by return descriptions among other improvements. Also, the scripts now handle signal and property comment blocks somewhat better than before generating appropriate xml (like <signal name="Class::a-signal">...</signal>) and including to the entire name of the signal/property so it is clear as to which signal/property is being dealt with. The code may be more, but I think the modularity makes it easier to know what is happening. Following the patch, I'll attach some differences so that the original output can be compared to the new one.
Created attachment 158166 [details] [review] difference between glibmm's documentation xml
Created attachment 158167 [details] [review] difference between giomm's documentation xml
Created attachment 158168 [details] difference between gtkmm's documentation xml
Created attachment 158169 [details] [review] difference between gdkmm's documentation xml
Created attachment 158170 [details] [review] difference between atkmm's documentation xml
Are there plans to add parsing of enum documentation?
Absolutely, if it is useful. At this point it would be fairly trivial to add.
Many thanks, Jose, this seems like a big improvement. I think I maintain this particular file, so please commit, and please apply the changes for the XML files. Thanks again.
Committed the changes to the doc generation scripts with a couple of other minor enhancements. Also saved the generated XML doc files in the master branches of the relevant modules (glibmm and gtkmm). Glad to be useful.