[svn:parrot] r37877 - in trunk/config/gen/platform: cygwin darwin generic netbsd openbsd solaris win32
coke at svn.parrot.org
coke at svn.parrot.org
Thu Apr 2 20:20:23 UTC 2009
Author: coke
Date: Thu Apr 2 20:20:22 2009
New Revision: 37877
URL: https://trac.parrot.org/parrot/changeset/37877
Log:
[t/docs] fixup some function docs in these (not headerized) files.
These files may never be headerized, but we still enforce c_function_docs.t
Modified:
trunk/config/gen/platform/cygwin/math.c
trunk/config/gen/platform/darwin/dl.c
trunk/config/gen/platform/darwin/memalign.c
trunk/config/gen/platform/generic/dl.c
trunk/config/gen/platform/generic/env.c
trunk/config/gen/platform/generic/exec.c
trunk/config/gen/platform/generic/signal.c
trunk/config/gen/platform/generic/stat.c
trunk/config/gen/platform/generic/time.c
trunk/config/gen/platform/netbsd/math.c
trunk/config/gen/platform/openbsd/math.c
trunk/config/gen/platform/openbsd/memexec.c
trunk/config/gen/platform/solaris/math.c
trunk/config/gen/platform/solaris/time.c
trunk/config/gen/platform/win32/env.c
trunk/config/gen/platform/win32/exec.c
trunk/config/gen/platform/win32/stat.c
Modified: trunk/config/gen/platform/cygwin/math.c
==============================================================================
--- trunk/config/gen/platform/cygwin/math.c Thu Apr 2 20:18:19 2009 (r37876)
+++ trunk/config/gen/platform/cygwin/math.c Thu Apr 2 20:20:22 2009 (r37877)
@@ -1,6 +1,6 @@
/*
+ * Copyright (C) 2006-2009, Parrot Foundation.
* $Id$
- * Copyright (C) 2006-2007, Parrot Foundation.
*/
/*
@@ -64,8 +64,7 @@
#if NUMVAL_SIZE == 12 && DOUBLE_SIZE == 3 * INT_SIZE && PARROT_LITTLE_ENDIAN
/*
-=item C<int
-Parrot_signbit_l(long double x)>
+=item C<int Parrot_signbit_l(long double x)>
Same as Parrot_signbit for long double.
Modified: trunk/config/gen/platform/darwin/dl.c
==============================================================================
--- trunk/config/gen/platform/darwin/dl.c Thu Apr 2 20:18:19 2009 (r37876)
+++ trunk/config/gen/platform/darwin/dl.c Thu Apr 2 20:20:22 2009 (r37877)
@@ -1,6 +1,6 @@
/*
- * $Id$
* Copyright (C) 2004-2006, Parrot Foundation.
+ * $Id$
*/
/*
@@ -30,8 +30,8 @@
/*
-=item C<static const char *
-scan_paths(const char *filename, const char *libpath)>
+=item C<static const char * scan_paths(const char *filename, const char
+*libpath)>
Simple routine to walk a colon separated list of directories in a string
and check for a file in each one, returning the first match.
@@ -71,8 +71,7 @@
/*
-=item C<static const char *
-get_lib(const char *filename)>
+=item C<static const char * get_lib(const char *filename)>
Try to expand a filename input into a full file system path following
the behavior described in dyld(1). First looks for the file in
@@ -109,8 +108,7 @@
/*
-=item C<void *
-Parrot_dlopen(const char *filename)>
+=item C<void * Parrot_dlopen(const char *filename)>
=cut
@@ -173,8 +171,7 @@
/*
-=item C<const char *
-Parrot_dlerror(void)>
+=item C<const char * Parrot_dlerror(void)>
=cut
@@ -189,8 +186,7 @@
/*
-=item C<void *
-Parrot_dlsym(void *handle, const char *symbol)>
+=item C<void * Parrot_dlsym(void *handle, const char *symbol)>
=cut
@@ -244,8 +240,7 @@
/*
-=item C<int
-Parrot_dlclose(void *handle)>
+=item C<int Parrot_dlclose(void *handle)>
=cut
Modified: trunk/config/gen/platform/darwin/memalign.c
==============================================================================
--- trunk/config/gen/platform/darwin/memalign.c Thu Apr 2 20:18:19 2009 (r37876)
+++ trunk/config/gen/platform/darwin/memalign.c Thu Apr 2 20:20:22 2009 (r37877)
@@ -86,8 +86,7 @@
/*
-=item C<void *
-Parrot_memalign(size_t align, size_t size)>
+=item C<void * Parrot_memalign(size_t align, size_t size)>
=cut
@@ -169,8 +168,7 @@
/*
-=item C<void
-Parrot_free_memalign(void *p)>
+=item C<void Parrot_free_memalign(void *p)>
=cut
Modified: trunk/config/gen/platform/generic/dl.c
==============================================================================
--- trunk/config/gen/platform/generic/dl.c Thu Apr 2 20:18:19 2009 (r37876)
+++ trunk/config/gen/platform/generic/dl.c Thu Apr 2 20:20:22 2009 (r37877)
@@ -29,8 +29,7 @@
/*
-=item C<void *
-Parrot_dlopen(const char *filename)>
+=item C<void * Parrot_dlopen(const char *filename)>
=cut
@@ -48,8 +47,7 @@
/*
-=item C<const char *
-Parrot_dlerror(void)>
+=item C<const char * Parrot_dlerror(void)>
=cut
@@ -67,8 +65,7 @@
/*
-=item C<void *
-Parrot_dlsym(void *handle, const char *symbol)>
+=item C<void * Parrot_dlsym(void *handle, const char *symbol)>
=cut
@@ -86,8 +83,7 @@
/*
-=item C<int
-Parrot_dlclose(void *handle)>
+=item C<int Parrot_dlclose(void *handle)>
=cut
Modified: trunk/config/gen/platform/generic/env.c
==============================================================================
--- trunk/config/gen/platform/generic/env.c Thu Apr 2 20:18:19 2009 (r37876)
+++ trunk/config/gen/platform/generic/env.c Thu Apr 2 20:20:22 2009 (r37877)
@@ -26,8 +26,7 @@
/*
-=item C<void
-Parrot_setenv(const char *name, const char *value)>
+=item C<void Parrot_setenv(const char *name, const char *value)>
=cut
@@ -60,8 +59,7 @@
/*
-=item C<void
-Parrot_unsetenv(const char *name)>
+=item C<void Parrot_unsetenv(const char *name)>
=cut
@@ -79,8 +77,7 @@
/*
-=item C<char *
-Parrot_getenv(const char *name, int *free_it)>
+=item C<char * Parrot_getenv(const char *name, int *free_it)>
=cut
Modified: trunk/config/gen/platform/generic/exec.c
==============================================================================
--- trunk/config/gen/platform/generic/exec.c Thu Apr 2 20:18:19 2009 (r37876)
+++ trunk/config/gen/platform/generic/exec.c Thu Apr 2 20:20:22 2009 (r37877)
@@ -26,8 +26,7 @@
/*
-=item C<INTVAL
-Parrot_Run_OS_Command(PARROT_INTERP, STRING *command)>
+=item C<INTVAL Parrot_Run_OS_Command(PARROT_INTERP, STRING *command)>
Spawn off a subprocess and wait for the damn thing to complete,
returning the return value of the process
@@ -71,8 +70,7 @@
/*
-=item C<INTVAL
-Parrot_Run_OS_Command_Argv(PARROT_INTERP, PMC *cmdargs)>
+=item C<INTVAL Parrot_Run_OS_Command_Argv(PARROT_INTERP, PMC *cmdargs)>
=cut
@@ -130,8 +128,7 @@
/*
-=item C<void
-Parrot_Exec_OS_Command(PARROT_INTERP, STRING *command)>
+=item C<void Parrot_Exec_OS_Command(PARROT_INTERP, STRING *command)>
=cut
Modified: trunk/config/gen/platform/generic/signal.c
==============================================================================
--- trunk/config/gen/platform/generic/signal.c Thu Apr 2 20:18:19 2009 (r37876)
+++ trunk/config/gen/platform/generic/signal.c Thu Apr 2 20:20:22 2009 (r37877)
@@ -26,8 +26,8 @@
/*
-=item C<Parrot_sighandler_t
-Parrot_set_sighandler(int signum, Parrot_sighandler_t handler)>
+=item C<Parrot_sighandler_t Parrot_set_sighandler(int signum,
+Parrot_sighandler_t handler)>
for now use signal based functions
Modified: trunk/config/gen/platform/generic/stat.c
==============================================================================
--- trunk/config/gen/platform/generic/stat.c Thu Apr 2 20:18:19 2009 (r37876)
+++ trunk/config/gen/platform/generic/stat.c Thu Apr 2 20:20:22 2009 (r37877)
@@ -24,8 +24,7 @@
/*
-=item C<PMC *
-Parrot_stat_file(PARROT_INTERP, STRING *filename)>
+=item C<PMC * Parrot_stat_file(PARROT_INTERP, STRING *filename)>
=cut
@@ -39,8 +38,8 @@
/*
-=item C<PMC *
-Parrot_stat_info_pmc(PARROT_INTERP, STRING *filename, INTVAL thing)>
+=item C<PMC * Parrot_stat_info_pmc(PARROT_INTERP, STRING *filename, INTVAL
+thing)>
=cut
@@ -54,8 +53,8 @@
/*
-=item C<static INTVAL
-stat_common(PARROT_INTERP, struct stat *statbuf, INTVAL thing, int status)>
+=item C<static INTVAL stat_common(PARROT_INTERP, struct stat *statbuf, INTVAL
+thing, int status)>
=cut
@@ -139,8 +138,8 @@
/*
-=item C<INTVAL
-Parrot_stat_info_intval(PARROT_INTERP, STRING *file, INTVAL thing)>
+=item C<INTVAL Parrot_stat_info_intval(PARROT_INTERP, STRING *file, INTVAL
+thing)>
=cut
@@ -162,8 +161,8 @@
/*
-=item C<INTVAL
-Parrot_fstat_info_intval(PARROT_INTERP, INTVAL file, INTVAL thing)>
+=item C<INTVAL Parrot_fstat_info_intval(PARROT_INTERP, INTVAL file, INTVAL
+thing)>
=cut
@@ -182,8 +181,8 @@
/*
-=item C<FLOATVAL
-Parrot_stat_info_floatval(PARROT_INTERP, STRING *filename, INTVAL thing)>
+=item C<FLOATVAL Parrot_stat_info_floatval(PARROT_INTERP, STRING *filename,
+INTVAL thing)>
=cut
@@ -197,8 +196,8 @@
/*
-=item C<STRING *
-Parrot_stat_info_string(PARROT_INTERP, STRING *filename, INTVAL thing)>
+=item C<STRING * Parrot_stat_info_string(PARROT_INTERP, STRING *filename, INTVAL
+thing)>
=cut
Modified: trunk/config/gen/platform/generic/time.c
==============================================================================
--- trunk/config/gen/platform/generic/time.c Thu Apr 2 20:18:19 2009 (r37876)
+++ trunk/config/gen/platform/generic/time.c Thu Apr 2 20:20:22 2009 (r37877)
@@ -26,8 +26,7 @@
/*
-=item C<INTVAL
-Parrot_intval_time(void)>
+=item C<INTVAL Parrot_intval_time(void)>
=cut
@@ -42,8 +41,7 @@
/*
-=item C<FLOATVAL
-Parrot_floatval_time(void)>
+=item C<FLOATVAL Parrot_floatval_time(void)>
=cut
@@ -59,8 +57,7 @@
/*
-=item C<void
-Parrot_sleep(unsigned int seconds)>
+=item C<void Parrot_sleep(unsigned int seconds)>
=cut
@@ -74,8 +71,7 @@
/*
-=item C<void
-Parrot_usleep(unsigned int microseconds)>
+=item C<void Parrot_usleep(unsigned int microseconds)>
Sleep for at least the specified number of microseconds (millionths of a
second).
@@ -92,8 +88,7 @@
/*
-=item C<struct tm *
-Parrot_gmtime_r(const time_t *t, struct tm *tm)>
+=item C<struct tm * Parrot_gmtime_r(const time_t *t, struct tm *tm)>
=cut
@@ -107,8 +102,7 @@
/*
-=item C<struct tm *
-Parrot_localtime_r(const time_t *t, struct tm *tm)>
+=item C<struct tm * Parrot_localtime_r(const time_t *t, struct tm *tm)>
=cut
@@ -122,8 +116,7 @@
/*
-=item C<char*
-Parrot_asctime_r(const struct tm *tm, char *buffer)>
+=item C<char* Parrot_asctime_r(const struct tm *tm, char *buffer)>
=cut
Modified: trunk/config/gen/platform/netbsd/math.c
==============================================================================
--- trunk/config/gen/platform/netbsd/math.c Thu Apr 2 20:18:19 2009 (r37876)
+++ trunk/config/gen/platform/netbsd/math.c Thu Apr 2 20:20:22 2009 (r37877)
@@ -61,8 +61,7 @@
#if NUMVAL_SIZE == 12 && DOUBLE_SIZE == 3 * INT_SIZE && PARROT_LITTLE_ENDIAN
/*
-=item C<int
-Parrot_signbit_l(long double x)>
+=item C<int Parrot_signbit_l(long double x)>
=cut
Modified: trunk/config/gen/platform/openbsd/math.c
==============================================================================
--- trunk/config/gen/platform/openbsd/math.c Thu Apr 2 20:18:19 2009 (r37876)
+++ trunk/config/gen/platform/openbsd/math.c Thu Apr 2 20:20:22 2009 (r37877)
@@ -60,8 +60,7 @@
#if NUMVAL_SIZE == 12 && DOUBLE_SIZE == 3 * INT_SIZE && PARROT_LITTLE_ENDIAN
/*
-=item C<int
-Parrot_signbit_l(long double x)>
+=item C<int Parrot_signbit_l(long double x)>
=cut
Modified: trunk/config/gen/platform/openbsd/memexec.c
==============================================================================
--- trunk/config/gen/platform/openbsd/memexec.c Thu Apr 2 20:18:19 2009 (r37876)
+++ trunk/config/gen/platform/openbsd/memexec.c Thu Apr 2 20:20:22 2009 (r37877)
@@ -24,8 +24,7 @@
#ifdef PARROT_HAS_EXEC_PROTECT
/*
-=item C<void *
-mem_alloc_executable(size_t size)>
+=item C<void * mem_alloc_executable(size_t size)>
Allocate executable memory
Round up to page size because the whole page will be marked as executable
@@ -50,8 +49,7 @@
/*
-=item C<void
-mem_free_executable(void *p)>
+=item C<void mem_free_executable(void *p)>
=cut
@@ -65,8 +63,7 @@
/*
-=item C<void *
-mem_realloc_executable(void* oldp, size_t newsize)>
+=item C<void * mem_realloc_executable(void* oldp, size_t newsize)>
Reallocate executable memory
Round up to page size because the whole page will be marked as executable
Modified: trunk/config/gen/platform/solaris/math.c
==============================================================================
--- trunk/config/gen/platform/solaris/math.c Thu Apr 2 20:18:19 2009 (r37876)
+++ trunk/config/gen/platform/solaris/math.c Thu Apr 2 20:20:22 2009 (r37877)
@@ -61,8 +61,7 @@
#if NUMVAL_SIZE == 12 && DOUBLE_SIZE == 3 * INT_SIZE && PARROT_LITTLE_ENDIAN
/*
-=item C<int
-Parrot_signbit_l(long double x)>
+=item C<int Parrot_signbit_l(long double x)>
=cut
Modified: trunk/config/gen/platform/solaris/time.c
==============================================================================
--- trunk/config/gen/platform/solaris/time.c Thu Apr 2 20:18:19 2009 (r37876)
+++ trunk/config/gen/platform/solaris/time.c Thu Apr 2 20:20:22 2009 (r37877)
@@ -26,8 +26,7 @@
/*
-=item C<INTVAL
-Parrot_intval_time(void)>
+=item C<INTVAL Parrot_intval_time(void)>
=cut
@@ -42,8 +41,7 @@
/*
-=item C<FLOATVAL
-Parrot_floatval_time(void)>
+=item C<FLOATVAL Parrot_floatval_time(void)>
=cut
@@ -59,8 +57,7 @@
/*
-=item C<void
-Parrot_sleep(unsigned int seconds)>
+=item C<void Parrot_sleep(unsigned int seconds)>
=cut
@@ -74,8 +71,7 @@
/*
-=item C<void
-Parrot_usleep(unsigned int microseconds)>
+=item C<void Parrot_usleep(unsigned int microseconds)>
Sleep for at least the specified number of microseconds (millionths of a
second).
@@ -92,8 +88,7 @@
/*
-=item C<struct tm *
-Parrot_gmtime_r(const time_t *t, struct tm *tm)>
+=item C<struct tm * Parrot_gmtime_r(const time_t *t, struct tm *tm)>
=cut
@@ -107,8 +102,7 @@
/*
-=item C<struct tm *
-Parrot_localtime_r(const time_t *t, struct tm *tm)>
+=item C<struct tm * Parrot_localtime_r(const time_t *t, struct tm *tm)>
=cut
@@ -122,8 +116,7 @@
/*
-=item C<char*
-Parrot_asctime_r(const struct tm *tm, char *buffer)>
+=item C<char* Parrot_asctime_r(const struct tm *tm, char *buffer)>
=cut
Modified: trunk/config/gen/platform/win32/env.c
==============================================================================
--- trunk/config/gen/platform/win32/env.c Thu Apr 2 20:18:19 2009 (r37876)
+++ trunk/config/gen/platform/win32/env.c Thu Apr 2 20:20:22 2009 (r37877)
@@ -81,8 +81,7 @@
/*
-=item C<char *
-Parrot_getenv(ARGIN(const char *name), NOTNULL(int *free_it))>
+=item C<char * Parrot_getenv(const char *name, int *free_it)>
Gets the environment variable C<name>, if it exists. Returns status in
C<free_it>. C<free_it> must be a non-null pointer to an integer to receive the
Modified: trunk/config/gen/platform/win32/exec.c
==============================================================================
--- trunk/config/gen/platform/win32/exec.c Thu Apr 2 20:18:19 2009 (r37876)
+++ trunk/config/gen/platform/win32/exec.c Thu Apr 2 20:20:22 2009 (r37877)
@@ -25,8 +25,7 @@
/*
-=item C<INTVAL
-Parrot_Run_OS_Command(PARROT_INTERP, STRING *command)>
+=item C<INTVAL Parrot_Run_OS_Command(PARROT_INTERP, STRING *command)>
Spawn the subprocess specified in C<command>.
Waits for the process to complete, and then
@@ -78,8 +77,7 @@
/*
-=item C<INTVAL
-Parrot_Run_OS_Command_Argv(PARROT_INTERP, PMC *cmdargs)>
+=item C<INTVAL Parrot_Run_OS_Command_Argv(PARROT_INTERP, PMC *cmdargs)>
Spawns a subprocess with the arguments provided in the C<cmdargs> PMC array.
The first array element should be the name of the process to spawn,
@@ -151,8 +149,7 @@
/*
-=item C<void
-Parrot_Exec_OS_Command(PARROT_INTERP, STRING *command)>
+=item C<void Parrot_Exec_OS_Command(PARROT_INTERP, STRING *command)>
Exits parrot and passes control to the specified process. Does not return. Raises an exception
if the exec fails.
Modified: trunk/config/gen/platform/win32/stat.c
==============================================================================
--- trunk/config/gen/platform/win32/stat.c Thu Apr 2 20:18:19 2009 (r37876)
+++ trunk/config/gen/platform/win32/stat.c Thu Apr 2 20:20:22 2009 (r37877)
@@ -24,8 +24,7 @@
/*
-=item C<PMC *
-Parrot_stat_file(PARROT_INTERP, STRING *filename)>
+=item C<PMC * Parrot_stat_file(PARROT_INTERP, STRING *filename)>
Stat a file. On Win32 this is not yet implemented, so we return a
C<NULL> PMC, not C<PMCNULL>.
@@ -42,8 +41,8 @@
/*
-=item C<PMC *
-Parrot_stat_info_pmc(PARROT_INTERP, STRING *filename, INTVAL thing)>
+=item C<PMC * Parrot_stat_info_pmc(PARROT_INTERP, STRING *filename, INTVAL
+thing)>
Return stat info on a file as a PMC. Not implemented on Win32, so we
return C<NULL>, not C<PMCNULL>.
@@ -60,8 +59,8 @@
/*
-=item C<static INTVAL
-stat_common(PARROT_INTERP, struct stat *statbuf, INTVAL thing, int status)>
+=item C<static INTVAL stat_common(PARROT_INTERP, struct stat *statbuf, INTVAL
+thing, int status)>
Stats the file, and returns the information specified by C<thing>. C<thing> can
be one of: C<STAT_EXISTS>, C<STAT_FILESIZE>, C<STAT_ISDIR>, C<STAT_ISDEV>,
@@ -159,8 +158,8 @@
/*
-=item C<INTVAL
-Parrot_stat_info_intval(PARROT_INTERP, STRING *file, INTVAL thing)>
+=item C<INTVAL Parrot_stat_info_intval(PARROT_INTERP, STRING *file, INTVAL
+thing)>
Returns the stat field given by C<thing> of file C<file>.
@@ -184,8 +183,8 @@
/*
-=item C<INTVAL
-Parrot_fstat_info_intval(PARROT_INTERP, INTVAL file, INTVAL thing)>
+=item C<INTVAL Parrot_fstat_info_intval(PARROT_INTERP, INTVAL file, INTVAL
+thing)>
Returns the fstat field given by C<thing> from file identifier C<file>.
@@ -206,8 +205,8 @@
/*
-=item C<FLOATVAL
-Parrot_stat_info_floatval(PARROT_INTERP, STRING *filename, INTVAL thing)>
+=item C<FLOATVAL Parrot_stat_info_floatval(PARROT_INTERP, STRING *filename,
+INTVAL thing)>
Currently returns C<-1.0> and has no side effects.
@@ -223,8 +222,8 @@
/*
-=item C<STRING *
-Parrot_stat_info_string(PARROT_INTERP, STRING *filename, INTVAL thing)>
+=item C<STRING * Parrot_stat_info_string(PARROT_INTERP, STRING *filename, INTVAL
+thing)>
Not implemented. Returns C<NULL>.
More information about the parrot-commits
mailing list