Evan Nemerson created THRIFT-1883:
-------------------------------------
Summary: 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
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
