Revert "Revert "Merge remote-tracking branch 'origin/sandbox/mniesluchow/upstream_2_1...

[platform/upstream/atk.git] / atk / atktablecell.c

diff --git a/atk/atktablecell.c b/atk/atktablecell.c
index 20baf1a..9b1c349 100644 (file)
--- a/atk/atktablecell.c
+++ b/atk/atktablecell.c
@@ -17,16 +17,32 @@
  * Boston, MA 02111-1307, USA.
  */
 
+#include "config.h"
+
 #include "atktablecell.h"
 
+
+/**
+ * SECTION:atktablecell
+ * @Short_description: The ATK interface implemented for a cell inside
+ * a two-dimentional #AtkTable
+ * @Title:AtkTableCell
+ *
+ * Being #AtkTable a component which present elements ordered via rows
+ * and columns, an #AtkTableCell is the interface which each of those
+ * elements, so "cells" should implement.
+ *
+ * See also #AtkTable.
+ */
+
 typedef AtkTableCellIface AtkTableCellInterface;
 G_DEFINE_INTERFACE (AtkTableCell, atk_table_cell, ATK_TYPE_OBJECT)
 
 static gboolean atk_table_cell_real_get_row_column_span (AtkTableCell *cell,
-                                                            gint         *row,
-                                                            gint         *column,
-                                                            gint         *row_span,
-                                                            gint         *column_span);
+                                                         gint         *row,
+                                                         gint         *column,
+                                                         gint         *row_span,
+                                                         gint         *column_span);
 
 static void
 atk_table_cell_default_init (AtkTableCellInterface *iface)
@@ -42,6 +58,8 @@ atk_table_cell_default_init (AtkTableCellInterface *iface)
  *
  * Returns: a gint representing the number of columns occupied by this cell,
  * or 0 if the cell does not implement this method.
+ *
+ * Since: 2.12
  */
 gint
 atk_table_cell_get_column_span (AtkTableCell *cell)
@@ -66,6 +84,8 @@ atk_table_cell_get_column_span (AtkTableCell *cell)
  *
  * Returns: (element-type AtkObject) (transfer full): a GPtrArray of AtkObjects
  * representing the column header cells.
+ *
+ * Since: 2.12
  */
 GPtrArray *
 atk_table_cell_get_column_header_cells (AtkTableCell *cell)
@@ -85,12 +105,14 @@ atk_table_cell_get_column_header_cells (AtkTableCell *cell)
 /**
  * atk_table_cell_get_position:
  * @cell: a GObject instance that implements AtkTableCellIface
- * row: (out): the row of the given cell.
- * column: (out): the column of the given cell.
+ * @row: (out): the row of the given cell.
+ * @column: (out): the column of the given cell.
  *
  * Retrieves the tabular position of this cell.
  *
  * Returns: TRUE if successful; FALSE otherwise.
+ *
+ * Since: 2.12
  */
 gboolean
 atk_table_cell_get_position (AtkTableCell *cell,
@@ -123,6 +145,8 @@ atk_table_cell_get_position (AtkTableCell *cell,
  *
  * Returns: a gint representing the number of rows occupied by this cell,
  * or 0 if the cell does not implement this method.
+ *
+ * Since: 2.12
  */
 gint
 atk_table_cell_get_row_span (AtkTableCell *cell)
@@ -147,6 +171,8 @@ atk_table_cell_get_row_span (AtkTableCell *cell)
  *
  * Returns: (element-type AtkObject) (transfer full): a GPtrArray of AtkObjects
  * representing the row header cells.
+ *
+ * Since: 2.12
  */
 GPtrArray *
 atk_table_cell_get_row_header_cells (AtkTableCell *cell)
@@ -178,13 +204,15 @@ atk_table_cell_get_row_header_cells (AtkTableCell *cell)
  * on the object.
  *
  * Returns: TRUE if successful; FALSE otherwise.
+ *
+ * Since: 2.12
  */
 gboolean
 atk_table_cell_get_row_column_span (AtkTableCell *cell,
-                                       gint *row,
-                                       gint *column,
-                                       gint *row_span,
-                                       gint *column_span)
+                                    gint         *row,
+                                    gint         *column,
+                                    gint         *row_span,
+                                    gint         *column_span)
 {
   AtkTableCellIface *iface;
   gint local_row = 0, local_column = 0;
@@ -216,6 +244,8 @@ atk_table_cell_get_row_column_span (AtkTableCell *cell,
  * Returns a reference to the accessible of the containing table.
  *
  * Returns: (transfer full): the atk object for the containing table.
+ *
+ * Since: 2.12
  */
 AtkObject *
 atk_table_cell_get_table (AtkTableCell *cell)
@@ -234,10 +264,10 @@ atk_table_cell_get_table (AtkTableCell *cell)
 
 static gboolean
 atk_table_cell_real_get_row_column_span (AtkTableCell *cell,
-                                            gint         *row,
-                                            gint         *column,
-                                            gint         *row_span,
-                                            gint         *column_span)
+                                         gint         *row,
+                                         gint         *column,
+                                         gint         *row_span,
+                                         gint         *column_span)
 {
   atk_table_cell_get_position (cell, row, column);
   *row_span = atk_table_cell_get_row_span (cell);