[svn:parrot] r48003 - branches/gsoc_threads/src

[mikehh at svn.parrot.org]

Author: mikehh
Date: Mon Jul  5 02:01:01 2010
New Revision: 48003
URL: https://trac.parrot.org/parrot/changeset/48003

Log:
fix C function docs =items

Modified:
   branches/gsoc_threads/src/alarm.c
   branches/gsoc_threads/src/scheduler.c

Modified: branches/gsoc_threads/src/alarm.c
==============================================================================
--- branches/gsoc_threads/src/alarm.c	Mon Jul  5 01:53:17 2010	(r48002)
+++ branches/gsoc_threads/src/alarm.c	Mon Jul  5 02:01:01 2010	(r48003)
@@ -19,6 +19,7 @@
 
 /* This file relies on POSIX. Probably need two other versions of it:
  *  one for Windows and one for platforms with no signals or threads. */
+
 #include <sys/time.h>
 #include <signal.h>
 #include <errno.h>
@@ -35,12 +36,16 @@
 
 
 /*
-=head1 Parrot_alarm_init()
+
+=over 4
+
+=item C<void Parrot_alarm_init(void)>
 
 Initialize the alarm queue. This function should only be called from the initial
 pthread. Any other pthreads should make sure to mask out SIGALRM.
 
 =cut
+
 */
 
 void Parrot_alarm_callback(SHIM(int sig_number));
@@ -65,11 +70,13 @@
 }
 
 /*
-=head1 Parrot_alarm_set(FLOATVAL when)
+
+=item C<static void set_posix_alarm(FLOATVAL wait)>
 
 A helper function to set an alarm.
 
 =cut
+
 */
 
 static void
@@ -97,11 +104,13 @@
 
 
 /*
-=head1 Parrot_alarm_callback()
+
+=item C<void Parrot_alarm_callback(int sig_number)>
 
 Callback for SIGALRM. When this is called, a timer should be ready to fire.
 
 =cut
+
 */
 
 void
@@ -130,7 +139,8 @@
 }
 
 /*
-=head1 Parrot_alarm_check(UINTVAL*)
+
+=item C<int Parrot_alarm_check(UINTVAL* last_serial)>
 
 Has any alarm triggered since we last checked?
 
@@ -138,6 +148,7 @@
 set the alarm.
 
 =cut
+
 */
 
 PARROT_EXPORT
@@ -156,11 +167,13 @@
 }
 
 /*
-=head1 Parrot_alarm_set(FLOATVAL when)
+
+=item C<void Parrot_alarm_set(FLOATVAL when)>
 
 Sets an alarm to trigger at time 'when'.
 
 =cut
+
 */
 
 PARROT_EXPORT

Modified: branches/gsoc_threads/src/scheduler.c
==============================================================================
--- branches/gsoc_threads/src/scheduler.c	Mon Jul  5 01:53:17 2010	(r48002)
+++ branches/gsoc_threads/src/scheduler.c	Mon Jul  5 02:01:01 2010	(r48003)
@@ -311,7 +311,7 @@
 
 /*
 
-=item C<void Parrot_cx_schedule_immediate(PARROT_INTERP, PMC *task) >
+=item C<void Parrot_cx_schedule_immediate(PARROT_INTERP, PMC *task)>
 
 Add a task to the task queue for immediate execution.
 
@@ -949,7 +949,7 @@
 
 /*
 
-=item C<void Parrot_cx_check_alarms(PARROT_INTERP, PMC *scheduler) >
+=item C<void Parrot_cx_check_alarms(PARROT_INTERP, PMC *scheduler)>
 
 Add the subs attached to any expired alarms to the task queue.