su: updated documentation

darcs-hash:20070226141131-55b16-98eaa75242673eb47c6ac5a840176f5737bd8eee.gz

libsofia-sip-ua/su/sofia-sip/su.h

@@ -220,13 +220,15 @@ typedef size_t su_ioveclen_t;
  * } WSABUF, *LPWSABUF;
  * @endcode
  *
- * @note Ordering of the fields is reversed on Windows. Do not initialize this
- * structure with static initializer, but assign both fields separately.
+ * @note Ordering of the fields is reversed on Windows. Do not initialize
+ * this structure with static initializer, but assign both fields
+ * separately. Note that the type of the siv_len is #su_ioveclen_t which is
+ * defined as u_long on Windows and size_t on POSIX.
  *
  * For historical reasons, the structure is known as #msg_iovec_t in @msg
  * module.
  *
- * @sa #su_iovec_t, #su_ioveclen_t, SU_IOVECLEN_MAX, su_vsend(), su_vrecv(), 
+ * @sa #su_ioveclen_t, SU_IOVECLEN_MAX, su_vsend(), su_vrecv(), 
  * #msg_iovec_t, msg_iovec(), msg_recv_iovec(), 
  * @c struct @c iovec defined in <sys/uio.h>, writev(2), readv(2),
  * sendmsg(), recvmsg(),

libsofia-sip-ua/su/su_base_port.c

@@ -23,7 +23,7 @@
  */
 
 /**@ingroup su_wait
- * @CFILE su_port.c
+ * @CFILE su_base_port.c
  *
  * OS-Independent Socket Syncronization Interface.
  *

libsofia-sip-ua/su/su_kqueue_port.c

@@ -23,7 +23,7 @@
  */
 
 /**@ingroup su_wait
- * @CFILE su_poll_port.c
+ * @CFILE su_kqueue_port.c
  *
  * Port implementation using kqueue()
  *

libsofia-sip-ua/su/su_timer.c

@@ -158,7 +158,7 @@ struct su_timer_s {
 };
 
 enum sut_running {
-  reset = 0,
+  reset = 0,		/**< Timer is not running */
   run_at_intervals = 1, /**< Compensate missed wakeup calls */
   run_for_ever = 2	/**< Do not compensate  */
 };