[svn:parrot] r47553 - branches/cfunctionsdocs/config/gen/platform/generic

[jkeenan at svn.parrot.org]

Author: jkeenan
Date: Fri Jun 11 01:33:17 2010
New Revision: 47553
URL: https://trac.parrot.org/parrot/changeset/47553

Log:
[codingstd] Provide documentation for C functions.

Modified:
   branches/cfunctionsdocs/config/gen/platform/generic/dl.c

Modified: branches/cfunctionsdocs/config/gen/platform/generic/dl.c
==============================================================================
--- branches/cfunctionsdocs/config/gen/platform/generic/dl.c	Fri Jun 11 01:26:41 2010	(r47552)
+++ branches/cfunctionsdocs/config/gen/platform/generic/dl.c	Fri Jun 11 01:33:17 2010	(r47553)
@@ -31,6 +31,9 @@
 
 =item C<void * Parrot_dlopen(const char *filename, Parrot_dlopen_flags flags)>
 
+Wrapper around C<dlopen>.  Loads dynamic library file named by first argument
+and returns a handle to it.
+
 =cut
 
 */
@@ -50,6 +53,9 @@
 
 =item C<const char * Parrot_dlerror(void)>
 
+Wrapper around C<dlerror>.  System-dependent string that indicates most recent
+failure in use of C<Parrot_dlopen>, C<Parrot_dlclose> or C<Parrot_dlsym>.
+
 =cut
 
 */
@@ -68,6 +74,9 @@
 
 =item C<void * Parrot_dlsym(void *handle, const char *symbol)>
 
+Wrapper around C<dlysm>.  Takes a handle returned by C<Parrot_dlopen> and
+returns address where symbol is located.
+
 =cut
 
 */
@@ -86,6 +95,9 @@
 
 =item C<int Parrot_dlclose(void *handle)>
 
+Wrapper around C<dl_close>.  Releases reference to dynamic library specified
+by argument.  Returns C<0> on success and C<-1> on failure.
+
 =cut
 
 */