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

[jkeenan at svn.parrot.org]

Author: jkeenan
Date: Thu Aug 12 01:40:48 2010
New Revision: 48426
URL: https://trac.parrot.org/parrot/changeset/48426

Log:
[codingstd] Insert POD 'item' so that documentor will know where to add function documentation.

Modified:
   trunk/src/pmc/complex.pmc

Modified: trunk/src/pmc/complex.pmc
==============================================================================
--- trunk/src/pmc/complex.pmc	Thu Aug 12 01:31:07 2010	(r48425)
+++ trunk/src/pmc/complex.pmc	Thu Aug 12 01:40:48 2010	(r48426)
@@ -13,14 +13,12 @@
 
 =head2 Functions
 
+Equations used are sometimes listed.  At times, multiple equations are given,
+but those starting with => are the ones used
+
 =over 4
 
 =cut
-    ASSERT_ARGS()
-
-
-Equations used are sometimes listed.  At times, multiple equations are given,
-but those starting with => are the ones used
 
 */
 
@@ -66,8 +64,7 @@
 
 /*
 
-=item C<static void complex_parse_string(PARROT_INTERP, FLOATVAL *re, FLOATVAL
-*im, STRING *value)>
+=item C<static void complex_parse_string(PARROT_INTERP, FLOATVAL *re, FLOATVAL *im, STRING *value)>
 
 Parses the string in C<value> to produce a complex number, represented
 by the real (C<*re>) and imaginary (C<*im>) parts. Raises an exception
@@ -77,6 +74,12 @@
 
 =cut
 
+We have a conflict among our coding standards here.  Our 100-character line
+limit meant that the following function declaration had to be split over two
+lines.  However, that leads to t/codingstd/pmc_docs.t reporting that this
+function lacks documentation -- reporting due to differences in whitespacing
+between '=item' and function declaration.
+
 */
 
 static void
@@ -238,6 +241,16 @@
     Parrot_str_free_cstring(str);
 }
 
+/*
+
+=item C<static void int_check_divide_zero(PARROT_INTERP, INTVAL value)>
+
+
+
+=cut
+
+*/
+
 static void
 int_check_divide_zero(PARROT_INTERP, INTVAL value)
 {
@@ -248,6 +261,16 @@
             "Divide by zero");
 }
 
+/*
+
+=item C<static void float_check_divide_zero(PARROT_INTERP, FLOATVAL value)>
+
+
+
+=cut
+
+*/
+
 static void
 float_check_divide_zero(PARROT_INTERP, FLOATVAL value)
 {
@@ -258,6 +281,16 @@
             "Divide by zero");
 }
 
+/*
+
+=item C<static void complex_check_divide_zero(PARROT_INTERP, PMC *value)>
+
+
+
+=cut
+
+*/
+
 static void
 complex_check_divide_zero(PARROT_INTERP, ARGIN(PMC *value))
 {