summaryrefslogtreecommitdiff
path: root/atspi/atspi-table.c
diff options
context:
space:
mode:
authorThomas Booker <tw.booker@outlook.com>2022-09-10 14:11:44 +1200
committerCoderThomasB <tw.booker@outlook.com>2022-09-28 09:37:27 +1300
commit837c050e48ea73f6dcf5ef9ff7120bc7da8b38ad (patch)
tree63f04cc81df87161f3d3c1ad5122b04a64741bc1 /atspi/atspi-table.c
parent35bcba928650b415b4d8a572b4d9b19384234ee6 (diff)
downloadat-spi2-core-837c050e48ea73f6dcf5ef9ff7120bc7da8b38ad.tar.gz
Docs: Move to gi-docgen
Diffstat (limited to 'atspi/atspi-table.c')
-rw-r--r--atspi/atspi-table.c16
1 files changed, 16 insertions, 0 deletions
diff --git a/atspi/atspi-table.c b/atspi/atspi-table.c
index 08718f4b..b2027e1e 100644
--- a/atspi/atspi-table.c
+++ b/atspi/atspi-table.c
@@ -26,6 +26,22 @@
#include "atspi-private.h"
/**
+ * AtspiTable:
+ *
+ * An interface used by containers whose data is arranged in a tabular form.
+ *
+ * An interface used by containers whose contained data is arranged
+ * in a tabular (i.e. row-column) form. Tables may resemble
+ * a two-dimensional grid, as in a spreadsheet, or may feature objects
+ * which span multiple rows and/or columns, but whose bounds are
+ * aligned on a row/column matrix. Objects within tables are children
+ * of the table object, and they may be referenced either via a child
+ * index or via a row/column pair. Table 'cells' may implement other
+ * interfaces, such as Text, Action, Image, and Component, and should do
+ * so as appropriate to their onscreen rresentation and/or behavior.
+ */
+
+/**
* atspi_table_get_caption:
* @obj: a pointer to the #AtspiTable implementor on which to operate.
*