Add valadoc comment to each public class.

https://bugzilla.gnome.org/show_bug.cgi?id=687244

13 files changed, 59 insertions, 0 deletions

diff --git a/libcaribou/column-model.vala b/libcaribou/column-model.vala
index f127a10..66e8428 100644
--- a/libcaribou/column-model.vala
+++ b/libcaribou/column-model.vala
@@ -1,4 +1,7 @@
 namespace Caribou {
+    /**
+     * Object representing a column in a row.
+     */
     public class ColumnModel : ScannableGroup, IScannableItem, IKeyboardObject {
         public bool scan_stepping { get; set; }
         public bool scan_selected { get; set; }
diff --git a/libcaribou/group-model.vala b/libcaribou/group-model.vala
index 0107822..8bcd704 100644
--- a/libcaribou/group-model.vala
+++ b/libcaribou/group-model.vala
@@ -1,4 +1,11 @@
 namespace Caribou {
+    /**
+     * Object representing a group in a keyboard.
+     *
+     * This is used for implementing custom keyboard service.
+     *
+     * A group object consists of {@link LevelModel} objects.
+     */
     public class GroupModel : Object, IKeyboardObject {
         public string active_level { get; private set; }
 
diff --git a/libcaribou/ikeyboard-object.vala b/libcaribou/ikeyboard-object.vala
index ce865d0..c63a46e 100644
--- a/libcaribou/ikeyboard-object.vala
+++ b/libcaribou/ikeyboard-object.vala
@@ -1,4 +1,9 @@
 namespace Caribou {
+	/**
+	 * Common interface providing access to keys.
+	 *
+	 * This is implemented by all the keyboard components.
+	 */
     public interface IKeyboardObject : Object {
         public abstract IKeyboardObject[] get_children ();
 
diff --git a/libcaribou/iscannable-group.vala b/libcaribou/iscannable-group.vala
index 44f3979..7c5e3f9 100644
--- a/libcaribou/iscannable-group.vala
+++ b/libcaribou/iscannable-group.vala
@@ -1,4 +1,7 @@
 namespace Caribou {
+    /**
+     * Interface implemented by containers of selectable items in scanning mode.
+     */
     public interface IScannableGroup : Object {
         public abstract IScannableItem? child_select ();
         public abstract void scan_reset ();
diff --git a/libcaribou/iscannable-item.vala b/libcaribou/iscannable-item.vala
index 7ce78a9..725ad7d 100644
--- a/libcaribou/iscannable-item.vala
+++ b/libcaribou/iscannable-item.vala
@@ -1,4 +1,7 @@
 namespace Caribou {
+    /**
+     * Interface implemented by items that can be selected in scanning mode.
+     */
     public interface IScannableItem : Object {
         public abstract bool scan_stepping { get; set; }
         public abstract bool scan_selected { get; set; }
diff --git a/libcaribou/key-model.vala b/libcaribou/key-model.vala
index f4f4c17..8709280 100644
--- a/libcaribou/key-model.vala
+++ b/libcaribou/key-model.vala
@@ -1,4 +1,9 @@
 namespace Caribou {
+    /**
+     * Object representing a key in a column.
+     *
+     * This is used for implementing custom keyboard service.
+     */
     public class KeyModel : GLib.Object, IScannableItem, IKeyboardObject {
         public string align { get; set; default = "center"; }
         public double width { get; set; default = 1.0; }
diff --git a/libcaribou/keyboard-model.vala b/libcaribou/keyboard-model.vala
index b40a557..785a668 100644
--- a/libcaribou/keyboard-model.vala
+++ b/libcaribou/keyboard-model.vala
@@ -1,4 +1,11 @@
 namespace Caribou {
+    /**
+     * Object representing a whole keyboard.
+     *
+     * This is used for implementing custom keyboard service.
+     *
+     * A keyboard object consists of {@link GroupModel} objects.
+     */
     public class KeyboardModel : Object, IKeyboardObject {
         public string active_group { get; private set; default = ""; }
         public string keyboard_type { get; construct; }
diff --git a/libcaribou/keyboard-service.vala b/libcaribou/keyboard-service.vala
index 6eae5ca..8a64cc4 100644
--- a/libcaribou/keyboard-service.vala
+++ b/libcaribou/keyboard-service.vala
@@ -1,4 +1,7 @@
 namespace Caribou {
+    /**
+     * Base abstract class of the Caribou D-Bus service.
+     */
     [DBus(name = "org.gnome.Caribou.Keyboard")]
     public abstract class KeyboardService : Object {
         public abstract void set_cursor_location(int x, int y, int w, int h);
diff --git a/libcaribou/level-model.vala b/libcaribou/level-model.vala
index e55526c..4ca3382 100644
--- a/libcaribou/level-model.vala
+++ b/libcaribou/level-model.vala
@@ -1,4 +1,11 @@
 namespace Caribou {
+    /**
+     * Object representing a level in a group.
+     *
+     * This is used for implementing custom keyboard service.
+     *
+     * A keyboard object consists of {@link RowModel} objects.
+     */
     public class LevelModel : ScannableGroup, IKeyboardObject {
         public signal void level_toggled (string new_level);
         public string mode { get; private set; default = ""; }
diff --git a/libcaribou/row-model.vala b/libcaribou/row-model.vala
index e74d887..83ba56e 100644
--- a/libcaribou/row-model.vala
+++ b/libcaribou/row-model.vala
@@ -1,4 +1,11 @@
 namespace Caribou {
+    /**
+     * Object representing a row in a level.
+     *
+     * This is used for implementing custom keyboard service.
+     *
+     * A keyboard object consists of {@link ColumnModel} objects.
+     */
     public class RowModel : ScannableGroup, IScannableItem, IKeyboardObject {
         public bool scan_stepping { get; set; }
         public bool scan_selected { get; set; }
diff --git a/libcaribou/scannable-group.vala b/libcaribou/scannable-group.vala
index 994dbec..6716512 100644
--- a/libcaribou/scannable-group.vala
+++ b/libcaribou/scannable-group.vala
@@ -1,4 +1,7 @@
 namespace Caribou {
+    /**
+     * Base abstract class that implements scanning mode containers.
+     */
     public abstract class ScannableGroup : Object, IScannableGroup {
         private Gee.LinkedList<IScannableItem> _step_path;
         private Gee.LinkedList<IScannableItem> _selected_path;
diff --git a/libcaribou/scanner.vala b/libcaribou/scanner.vala
index 89ce892..7d14a0a 100644
--- a/libcaribou/scanner.vala
+++ b/libcaribou/scanner.vala
@@ -1,4 +1,7 @@
 namespace Caribou {
+    /**
+     * Object providing access to keyboard in scanning mode.
+     */
     public class Scanner : Object {
         public bool bind_settings { get; construct; default=true; }
 
diff --git a/libcaribou/xadapter.vala b/libcaribou/xadapter.vala
index 012c42d..62ec4cc 100644
--- a/libcaribou/xadapter.vala
+++ b/libcaribou/xadapter.vala
@@ -1,4 +1,7 @@
 namespace Caribou {
+    /**
+     * Singleton object providing access to the X Window facility.
+     */
     public class XAdapter : Object {
 
         /* Signals */