[svn:parrot] r45474 - trunk/src/nci

[plobsing at svn.parrot.org]

Author: plobsing
Date: Fri Apr  9 00:54:11 2010
New Revision: 45474
URL: https://trac.parrot.org/parrot/changeset/45474

Log:
make documentation readable with perldoc

Modified:
   trunk/src/nci/api.c

Modified: trunk/src/nci/api.c
==============================================================================
--- trunk/src/nci/api.c	Fri Apr  9 00:33:50 2010	(r45473)
+++ trunk/src/nci/api.c	Fri Apr  9 00:54:11 2010	(r45474)
@@ -1,15 +1,23 @@
 /* nci.c
- *  Copyright (C) 2001-2009, Parrot Foundation.
- *  SVN Info
- *     $Id$
- *  Overview:
- *     Native Call Interface routines. The code needed to build a
- *     parrot to C call frame is in here
- *  Data Structure and Algorithms:
- *  History:
- *  Notes:
- *  References:
- */
+Copyright (C) 2001-2009, Parrot Foundation.
+$Id$
+
+=head1 NAME
+
+src/nci/api.c - Native Call Interface routines
+
+=head1 DESCRIPTION
+
+This file implements the interface to the Parrot Native Call Interface system,
+which builds parrot to C call frames.
+
+=head2 Functions
+
+=over 4
+
+=cut
+
+*/
 
 #include "parrot/parrot.h"
 #include "parrot/nci.h"
@@ -19,8 +27,6 @@
 
 /*
 
-=pod
-
 =item C<PMC * build_call_func(PARROT_INTERP, STRING *signature)>
 
 This function serves a single purpose. It takes the function signature for a
@@ -66,6 +72,14 @@
 }
 
 /*
+
+=back
+
+=cut
+
+*/
+
+/*
  * Local variables:
  *   c-file-style: "parrot"
  * End: