From 2b5dae761ba1727cb483f4bae334a1b25f222e18 Mon Sep 17 00:00:00 2001
From: Simon Howard
Date: Sat, 7 Mar 2009 00:24:45 +0000
Subject: Add documentation for high-level textscreen functions.

Subversion-branch: /trunk/chocolate-doom
Subversion-revision: 1449
---
 textscreen/txt_strut.h | 20 +++++++++++++++-----
 1 file changed, 15 insertions(+), 5 deletions(-)

(limited to 'textscreen/txt_strut.h')

diff --git a/textscreen/txt_strut.h b/textscreen/txt_strut.h
index 7d9e7650..8436aa9c 100644
--- a/textscreen/txt_strut.h
+++ b/textscreen/txt_strut.h
@@ -22,15 +22,18 @@
 #ifndef TXT_STRUT_H
 #define TXT_STRUT_H
 
+/**
+ * Strut widget.
+ *
+ * A strut is a widget that takes up a fixed amount of space.  It can
+ * be visualised as a transparent box.  Struts are used to provide
+ * spacing between widgets.
+ */
+
 typedef struct txt_strut_s txt_strut_t;
 
 #include "txt_widget.h"
 
-//
-// A strut is used to force a table to a minimum width/height.  It is not
-// visible but it takes up space.
-// 
-
 struct txt_strut_s
 {
     txt_widget_t widget;
@@ -38,6 +41,13 @@ struct txt_strut_s
     int height;
 };
 
+/**
+ * Create a new strut.
+ *
+ * @param width      Width of the strut, in characters.
+ * @param height     Height of the strut, in characters.
+ */
+
 txt_strut_t *TXT_NewStrut(int width, int height);
 
 #endif /* #ifndef TXT_STRUT_H */
-- 
cgit v1.2.3


From f9c51c1b5c78234a138f9f44c261990336b445e7 Mon Sep 17 00:00:00 2001
From: Simon Howard
Date: Sun, 8 Mar 2009 22:51:25 +0000
Subject: Add "make doc" target to run Doxygen, and add a Doxyfile. Add @file
 tags to start of header files so that Doxygen will process them.

Subversion-branch: /trunk/chocolate-doom
Subversion-revision: 1451
---
 textscreen/txt_strut.h | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to 'textscreen/txt_strut.h')

diff --git a/textscreen/txt_strut.h b/textscreen/txt_strut.h
index 8436aa9c..3dc8db9a 100644
--- a/textscreen/txt_strut.h
+++ b/textscreen/txt_strut.h
@@ -22,6 +22,12 @@
 #ifndef TXT_STRUT_H
 #define TXT_STRUT_H
 
+/**
+ * @file txt_strut.h
+ *
+ * Strut widget.
+ */
+
 /**
  * Strut widget.
  *
-- 
cgit v1.2.3