[
https://issues.apache.org/jira/browse/THRIFT-1883?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Evan Nemerson updated THRIFT-1883:
----------------------------------
Attachment: 0004-Add-gtk-doc-comments-to-c_glib-code.patch
0003-Use-gtk-doc-for-thrift_c_glib.patch
Hopefully these apply cleanly. If not, you might need
https://github.com/nemequ/thrift/commit/0fc8b2a664e8a1fb7f828cf0795a1243d90c8c7d
(which I've also attached to THRIFT-1879) and
https://github.com/nemequ/thrift/commit/a24b256c62ea65890f19f4a93f582ee6c35da53c
(which I've also attached to THRIFT-1882).
> Add GTK-Doc documentation
> -------------------------
>
> Key: THRIFT-1883
> URL: https://issues.apache.org/jira/browse/THRIFT-1883
> Project: Thrift
> Issue Type: Improvement
> Components: C glib - Library
> Reporter: Evan Nemerson
> Priority: Minor
> Attachments: 0003-Use-gtk-doc-for-thrift_c_glib.patch,
> 0004-Add-gtk-doc-comments-to-c_glib-code.patch
>
>
> Right now thrift_c_glib contains a few sporadic doxygen-style comments which
> are, AFAICT, not actually used to generate any documentation.
> In order to generate a GObject Introspection repository g-ir-scanner scans
> the source code and looks for GTK-Doc comments which contain annotations (see
> https://live.gnome.org/GObjectIntrospection/Annotations) necessary for the
> GIR to work properly.
> I've fully documented thrift_c_glib (well, the API is fully covered, although
> I'm the first to admit the documentation could be better) using GTK-Doc
> comments and added support to the build system to go ahead and actually build
> a manual.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira
