[svn:parrot] r47554 - in branches/cfunctionsdocs: config/gen/platform/ansi config/gen/platform/generic t/codingstd

jkeenan at svn.parrot.org jkeenan at svn.parrot.org
Fri Jun 11 01:48:45 UTC 2010


Author: jkeenan
Date: Fri Jun 11 01:48:45 2010
New Revision: 47554
URL: https://trac.parrot.org/parrot/changeset/47554

Log:
[codingstd] Provide documentation for C functions.

Modified:
   branches/cfunctionsdocs/config/gen/platform/ansi/dl.c
   branches/cfunctionsdocs/config/gen/platform/generic/dl.c
   branches/cfunctionsdocs/t/codingstd/c_function_docs.t

Modified: branches/cfunctionsdocs/config/gen/platform/ansi/dl.c
==============================================================================
--- branches/cfunctionsdocs/config/gen/platform/ansi/dl.c	Fri Jun 11 01:33:17 2010	(r47553)
+++ branches/cfunctionsdocs/config/gen/platform/ansi/dl.c	Fri Jun 11 01:48:45 2010	(r47554)
@@ -11,20 +11,15 @@
 
 =head1 DESCRIPTION
 
-Dynlib stuff.  (Currently, just placeholders.)
+Parrot functions -- B<none yet implemented> -- which wrap around standard library functions for handling dynamic libraries.
 
 =head2 Functions
 
 =over 4
 
-=cut
-
-*/
-
-/*
+=item C<void * Parrot_dlopen(const char *filename, Parrot_dlopen_flags flags)>
 
-=item C<void * Parrot_dlopen(const char *filename, SHIM(Parrot_dlopen_flags
-flags)>
+Parrot wrapper around C<dlopen>.  B<Not yet implemented.>
 
 =cut
 
@@ -42,6 +37,8 @@
 
 =item C<const char * Parrot_dlerror(void)>
 
+Parrot wrapper around C<dlerror>.  B<Not yet implemented.>
+
 =cut
 
 */
@@ -57,6 +54,8 @@
 
 =item C<void * Parrot_dlsym(void *handle, const char *symbol)>
 
+Parrot wrapper around C<dlsym>.  B<Not yet implemented.>
+
 =cut
 
 */
@@ -73,6 +72,8 @@
 
 =item C<int Parrot_dlclose(void *handle)>
 
+Parrot wrapper around C<dlclose>.  B<Not yet implemented.>
+
 =cut
 
 */

Modified: branches/cfunctionsdocs/config/gen/platform/generic/dl.c
==============================================================================
--- branches/cfunctionsdocs/config/gen/platform/generic/dl.c	Fri Jun 11 01:33:17 2010	(r47553)
+++ branches/cfunctionsdocs/config/gen/platform/generic/dl.c	Fri Jun 11 01:48:45 2010	(r47554)
@@ -11,7 +11,7 @@
 
 =head1 DESCRIPTION
 
-Dynlib stuff
+Parrot functions which wrap around standard library functions for handling dynamic libraries.
 
 =head2 Functions
 

Modified: branches/cfunctionsdocs/t/codingstd/c_function_docs.t
==============================================================================
--- branches/cfunctionsdocs/t/codingstd/c_function_docs.t	Fri Jun 11 01:33:17 2010	(r47553)
+++ branches/cfunctionsdocs/t/codingstd/c_function_docs.t	Fri Jun 11 01:48:45 2010	(r47554)
@@ -92,11 +92,9 @@
 
 __DATA__
 compilers/pirc/src/pircapi.c
-config/gen/platform/ansi/dl.c
 config/gen/platform/ansi/exec.c
 config/gen/platform/ansi/time.c
 config/gen/platform/darwin/memalign.c
-config/gen/platform/generic/dl.c
 config/gen/platform/generic/exec.c
 config/gen/platform/generic/math.c
 config/gen/platform/generic/memalign.c


More information about the parrot-commits mailing list