CVS shishi/lib

[shishi-commit]

Update of /home/cvs/shishi/lib
In directory dopio:/tmp/cvs-serv4965

Modified Files:
        tkts.c 
Log Message:
Doc fix.


--- /home/cvs/shishi/lib/tkts.c 2004/09/08 12:58:48     1.41
+++ /home/cvs/shishi/lib/tkts.c 2004/11/09 19:12:14     1.42
@@ -56,6 +56,8 @@
  * shishi_tkts_default_file:
  * @handle: Shishi library handle create by shishi_init().
  *
+ * Get filename of default ticket set.
+ *
  * Return value: Returns the default ticket set filename used in the
  * library.  The string is not a copy, so don't modify or deallocate
  * it.
@@ -100,6 +102,8 @@
  * shishi_tkts_default:
  * @handle: Shishi library handle create by shishi_init().
  *
+ * Get the default ticket set for library handle.
+ *
  * Return value: Return the handle global ticket set.
  **/
 Shishi_tkts *
@@ -123,6 +127,8 @@
  * @handle: shishi handle as allocated by shishi_init().
  * @tkts: output pointer to newly allocated tkts handle.
  *
+ * Get a new ticket set handle.
+ *
  * Return value: Returns %SHISHI_OK iff successful.
  **/
 int
@@ -164,6 +170,8 @@
  * shishi_tkts_size:
  * @tkts: ticket set handle as allocated by shishi_tkts().
  *
+ * Get size of ticket set.
+ *
  * Return value: Returns number of tickets stored in ticket set.
  **/
 int
@@ -177,10 +185,12 @@
  * @tkts: ticket set handle as allocated by shishi_tkts().
  * @ticketno: integer indicating requested ticket in ticket set.
  *
+ * Get the n:th ticket in ticket set.
+ *
  * Return value: Returns a ticket handle to the ticketno:th ticket in
- * the ticket set, or NULL if ticket set is invalid or ticketno is out
- * of bounds.  The first ticket is ticketno 0, the second ticketno 1,
- * and so on.
+ *   the ticket set, or NULL if ticket set is invalid or ticketno is
+ *   out of bounds.  The first ticket is ticketno 0, the second
+ *   ticketno 1, and so on.
  **/
 Shishi_tkt *
 shishi_tkts_nth (Shishi_tkts * tkts, int ticketno)
@@ -195,10 +205,12 @@
  * shishi_tkts_remove:
  * @tkts: ticket set handle as allocated by shishi_tkts().
  * @ticketno: ticket number of ticket in the set to remove.  The first
- * ticket is ticket number 0.
+ *   ticket is ticket number 0.
+ *
+ * Remove a ticket, indexed by @ticketno, in ticket set.
  *
- * Return value: Returns SHISHI_OK if succesful or if ticketno
- * larger than size of ticket set.
+ * Return value: Returns SHISHI_OK if succesful or if ticketno larger
+ *   than size of ticket set.
  **/
 int
 shishi_tkts_remove (Shishi_tkts * tkts, int ticketno)
@@ -234,6 +246,10 @@
  * @tkts: ticket set handle as allocated by shishi_tkts().
  * @tkt: ticket to be added to ticket set.
  *
+ * Add a ticket to the ticket set.  Only the pointer is stored, so if
+ * you modify @tkt, the ticket in the ticket set will also be
+ * modified.
+ *
  * Return value: Returns SHISHI_OK iff succesful.
  **/
 int