[svn:parrot] r48500 - trunk/src/pmc

[jkeenan at svn.parrot.org]

Author: jkeenan
Date: Sun Aug 15 02:03:53 2010
New Revision: 48500
URL: https://trac.parrot.org/parrot/changeset/48500

Log:
Insert POD 'item' so that documentor will know where to add PMC function documentation.  In several places, convert inline comments to POD.

Modified:
   trunk/src/pmc/imageio.pmc

Modified: trunk/src/pmc/imageio.pmc
==============================================================================
--- trunk/src/pmc/imageio.pmc	Sun Aug 15 01:48:12 2010	(r48499)
+++ trunk/src/pmc/imageio.pmc	Sun Aug 15 02:03:53 2010	(r48500)
@@ -10,6 +10,10 @@
 
 Freezes and thaws other PMCs.
 
+=head1 FUNCTIONS
+
+=over 4
+
 =cut
 
 */
@@ -119,6 +123,16 @@
 /* Don't modify between HEADERIZER BEGIN / HEADERIZER END.  Your changes will be lost. */
 /* HEADERIZER END: static */
 
+/*
+
+=item C<static opcode_t * GET_VISIT_CURSOR(const PMC *pmc)>
+
+
+
+=cut
+
+*/
+
 PARROT_INLINE
 PARROT_CANNOT_RETURN_NULL
 PARROT_WARN_UNUSED_RESULT
@@ -132,6 +146,16 @@
     return (opcode_t *)(buf + pos);
 }
 
+/*
+
+=item C<static void SET_VISIT_CURSOR(PMC *pmc, const char *cursor)>
+
+
+
+=cut
+
+*/
+
 
 PARROT_INLINE
 static void
@@ -143,6 +167,16 @@
     PARROT_IMAGEIO(pmc)->pos = (cursor - bufstart);
 }
 
+/*
+
+=item C<static void INC_VISIT_CURSOR(PMC *pmc, UINTVAL inc)>
+
+
+
+=cut
+
+*/
+
 
 PARROT_INLINE
 static void
@@ -157,6 +191,16 @@
 #define BYTECODE_SHIFT_OK(pmc) PARROT_ASSERT( \
     PARROT_IMAGEIO(pmc)->pos <= PARROT_IMAGEIO(pmc)->input_length)
 
+/*
+
+=item C<static void create_buffer(PARROT_INTERP, PMC *pmc, PMC *info)>
+
+
+
+=cut
+
+*/
+
 static void
 create_buffer(PARROT_INTERP, ARGIN_NULLOK(PMC *pmc), ARGMOD(PMC *info))
 {
@@ -185,13 +229,15 @@
         (const char *)Buffer_bufstart(PARROT_IMAGEIO(info)->buffer));
 }
 
-
 /*
-static void ensure_buffer_size(PARROT_INTERP, PMC *io, size_t len)
 
-Checks the size of the buffer to see if it can accommodate 'len' more
+=item C<static void ensure_buffer_size(PARROT_INTERP, PMC *io, size_t len)>
+
+Checks the size of the buffer to see if it can accommodate C<len> more
 bytes. If not, expands the buffer.
 
+=cut
+
 */
 
 PARROT_INLINE
@@ -220,6 +266,15 @@
 #endif
 }
 
+/*
+
+=item C<static INTVAL INFO_HAS_DATA(const PMC *io)>
+
+
+
+=cut
+
+*/
 
 PARROT_WARN_UNUSED_RESULT
 PARROT_INLINE
@@ -231,6 +286,15 @@
     return PARROT_IMAGEIO(io)->pos < PARROT_IMAGEIO(io)->input_length;
 }
 
+/*
+
+=item C<static PMC* id_list_get(PARROT_INTERP, const PMC *io, UINTVAL id)>
+
+
+
+=cut
+
+*/
 
 PARROT_WARN_UNUSED_RESULT
 PARROT_CAN_RETURN_NULL
@@ -243,6 +307,16 @@
     return VTABLE_get_pmc_keyed_int(interp, PARROT_IMAGEIO(io)->todo, id - 1);
 }
 
+/*
+
+=item C<static PMC * visit_todo_list_thaw(PARROT_INTERP, PMC* info)>
+
+
+
+=cut
+
+*/
+
 
 PARROT_WARN_UNUSED_RESULT
 PARROT_CAN_RETURN_NULL
@@ -294,6 +368,16 @@
     return pmc;
 }
 
+/*
+
+=item C<static void visit_todo_list_freeze(PARROT_INTERP, PMC* pmc, PMC* info)>
+
+
+
+=cut
+
+*/
+
 
 static void
 visit_todo_list_freeze(PARROT_INTERP, ARGIN_NULLOK(PMC* pmc), ARGMOD(PMC* info))
@@ -361,6 +445,8 @@
 
 /*
 
+=back
+
 =head1 VTABLES
 
 =over 4