Add documentation for high-level textscreen functions.

Subversion-branch: /trunk/chocolate-doom
Subversion-revision: 1449

1 files changed, 17 insertions, 0 deletions

diff --git a/textscreen/txt_separator.h b/textscreen/txt_separator.h
index c8691171..518a56c9 100644
--- a/textscreen/txt_separator.h
+++ b/textscreen/txt_separator.h
@@ -22,6 +22,15 @@
 #ifndef TXT_SEPARATOR_H
 #define TXT_SEPARATOR_H
 
+/**
+ * Horizontal separator.
+ *
+ * A horizontal separator appears as a horizontal line divider across
+ * the length of the window in which it is added.  An optional label
+ * allows the separator to be used as a section divider for grouping
+ * related controls.
+ */
+
 typedef struct txt_separator_s txt_separator_t;
 
 #include "txt_widget.h"
@@ -34,6 +43,14 @@ struct txt_separator_s
 
 extern txt_widget_class_t txt_separator_class;
 
+/**
+ * Create a new horizontal separator widget.
+ *
+ * @param label         Label to display on the separator.  If this is
+ *                      set to NULL, no label is displayed.
+ * @return              The new separator widget.
+ */
+
 txt_separator_t *TXT_NewSeparator(char *label);
 
 #endif /* #ifndef TXT_SEPARATOR_H */