From: Andre Noll <maan@systemlinux.org>
Date: Mon, 31 Mar 2008 12:02:15 +0000 (+0200)
Subject: Documentation updates and cleanups.
X-Git-Tag: v0.3.2~43
X-Git-Url: http://git.tue.mpg.de/?a=commitdiff_plain;h=32d43fac23025e82b7a92bfce744207c69165a04;p=paraslash.git

Documentation updates and cleanups.
---

diff --git a/client_common.c b/client_common.c
index ee3a13f7..35220608 100644
--- a/client_common.c
+++ b/client_common.c
@@ -308,8 +308,8 @@ err_out:
  *
  * \param argc Usual argument count.
  * \param argv Usual argument vector.
- * \param pcd_ptr Points to dynamically allocated and initialized private client data
- * upon successful return.
+ * \param ct_ptr Points to dynamically allocated and initialized client task
+ * struct upon successful return.
  *
  * Check the command line options given by \a argc and argv, set default values
  * for user name and rsa key file, read further option from the config file.
diff --git a/sched.h b/sched.h
index c0e597eb..86afc6fc 100644
--- a/sched.h
+++ b/sched.h
@@ -1,14 +1,14 @@
 /*
- * Copyright (C) 2006 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2006-2008 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
-/** \file sched.h sched and task structures and exported symbols from sched.c */
+/** \file sched.h Sched and task structures and exported symbols from sched.c. */
 
 
 /**
- * paraslash's scheduler
+ * Paraslash's scheduler.
  *
  * Designed with KISS in mind. It manages two lists of tasks.  The pre_select
  * list contains pointers to functions that are called before calling select()
@@ -17,53 +17,50 @@
  * these lists by registering themselves to the scheduler.
  */
 struct sched {
-	/** initial value before any pre_select call */
+	/** Initial value before any pre_select call. */
 	struct timeval default_timeout;
-	/** the current timeout for the upcoming select call */
+	/** The current timeout for the upcoming select call. */
 	struct timeval timeout;
-	/** fds that should be watched for readability */
+	/** fds that should be watched for readability. */
 	fd_set rfds;
-	/** fds that should be watched for writability */
+	/** fds that should be watched for writability. */
 	fd_set wfds;
-	/** highest numbered file descriptor in any of the above fd sets */
+	/** Highest numbered file descriptor in any of the above fd sets. */
 	int max_fileno;
 };
 
 /**
- * paraslash's task structure
+ * Paraslash's task structure.
  *
- * before registering a task to the scheduler, the task structure must be
+ * Before registering a task to the scheduler, the task structure must be
  * filled in properly by the caller.
  *
- * If one of these functions return a negative value via \a t->ret the
- * (optional) event_handler gets called (it may also be called in case another
- * event happened). In many cases the only possible event is an error or an eof
- * condition and the event handler simply unregisters the task from the
- * scheduler.
+ * If one of these functions sets \a t->error to a negative value, the
+ * task gets unregistered automatically.
  *
- * \sa struct sched
+ * \sa struct sched.
  */
 struct task {
 	/**
-	 * the pre select hook of \a t
+	 * The pre select hook of \a t.
 	 *
 	 * Its purpose is to add file descriptors to the fd sets of the
 	 * scheduler and to decrease the select timeout if necessary.
 	 */
 	void (*pre_select)(struct sched *s, struct task *t);
 	/**
-	 * the postselect hook of \a t
+	 * The postselect hook of \a t.
 	 *
-	 * evaluate and act upon the results of the previous select call.
+	 * Evaluate and act upon the results of the previous select call.
 	 */
 	void (*post_select)(struct sched *s, struct task *t);
 	/** Whether this task is in error state. */
 	int error;
-	/** position of the task in the pre_select list of the scheduler */
+	/** Position of the task in the pre_select list of the scheduler. */
 	struct list_head pre_select_node;
-	/** position of the task in the post_select list of the scheduler */
+	/** Position of the task in the post_select list of the scheduler. */
 	struct list_head post_select_node;
-	/** descriptive text and current status of the task */
+	/** Descriptive text and current status of the task. */
 	char status[MAXLINE];
 };