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 687244 - Add documentation support
Add documentation support
Status: RESOLVED FIXED
Product: caribou
Classification: Applications
Component: default
git master
Other All
: Normal normal
: ---
Assigned To: caribou-maint
caribou-maint
Depends on:
Blocks:
 
 
Reported: 2012-10-31 03:21 UTC by Daiki Ueno
Modified: 2012-12-30 05:17 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Add documentation support (4.42 KB, patch)
2012-10-31 03:21 UTC, Daiki Ueno
committed Details | Review
Add valadoc comment to each public class. (7.20 KB, patch)
2012-12-30 00:07 UTC, Daiki Ueno
committed Details | Review

Description Daiki Ueno 2012-10-31 03:21:33 UTC
libcaribou currently lacks documentation and it would be nice to have.
Comment 1 Daiki Ueno 2012-10-31 03:21:35 UTC
Created attachment 227701 [details] [review]
Add documentation support

Add Valadoc documentation support in the build system.
The template is borrowed from Folks.
Comment 2 Eitan Isaacson 2012-10-31 14:53:50 UTC
Looks good. But I think there should actually be some documentation before committing this.
Comment 3 Daiki Ueno 2012-11-01 03:59:14 UTC
Sure, I'll add description of each class at least.
Comment 4 Daiki Ueno 2012-12-30 00:07:59 UTC
Created attachment 232380 [details] [review]
Add valadoc comment to each public class.
Comment 5 Daiki Ueno 2012-12-30 05:17:07 UTC
Attachment 227701 [details] pushed as 89b918d - Add documentation support
Attachment 232380 [details] pushed as c4f0a05 - Add valadoc comment to each public class.