[svn:parrot] r42783 - in trunk/lib/Parrot/Pmc2c: . PMC

jkeenan at svn.parrot.org jkeenan at svn.parrot.org
Sun Nov 22 04:18:48 UTC 2009


Author: jkeenan
Date: Sun Nov 22 04:18:46 2009
New Revision: 42783
URL: https://trac.parrot.org/parrot/changeset/42783

Log:
Add content to Pod DESCRIPTION (or make sure that DESCRIPTION passes codingstd test).

Modified:
   trunk/lib/Parrot/Pmc2c/Dumper.pm
   trunk/lib/Parrot/Pmc2c/Method.pm
   trunk/lib/Parrot/Pmc2c/Object.pm
   trunk/lib/Parrot/Pmc2c/PMC/Null.pm
   trunk/lib/Parrot/Pmc2c/PMC/Object.pm
   trunk/lib/Parrot/Pmc2c/PMC/ParrotClass.pm
   trunk/lib/Parrot/Pmc2c/PMC/default.pm
   trunk/lib/Parrot/Pmc2c/UtilFunctions.pm

Modified: trunk/lib/Parrot/Pmc2c/Dumper.pm
==============================================================================
--- trunk/lib/Parrot/Pmc2c/Dumper.pm	Sun Nov 22 03:57:16 2009	(r42782)
+++ trunk/lib/Parrot/Pmc2c/Dumper.pm	Sun Nov 22 04:18:46 2009	(r42783)
@@ -12,6 +12,18 @@
 use base 'Exporter';
 @Parrot::Pmc2c::Dumper::EXPORT_OK = 'dump_pmc';
 
+=head1 NAME
+
+Parrot::Pmc2c::Dumper
+
+=head1 DESCRIPTION
+
+Create dump file for PMCs.
+
+=head1 FUNCTIONS
+
+=head2 Public Functions
+
 =head3 C<dump_pmc()>
 
     $return_value = dump_pmc($pmc2cMain);

Modified: trunk/lib/Parrot/Pmc2c/Method.pm
==============================================================================
--- trunk/lib/Parrot/Pmc2c/Method.pm	Sun Nov 22 03:57:16 2009	(r42782)
+++ trunk/lib/Parrot/Pmc2c/Method.pm	Sun Nov 22 04:18:46 2009	(r42783)
@@ -9,6 +9,22 @@
 use constant MULTI        => 'MULTI';
 use Parrot::Pmc2c::UtilFunctions qw( args_from_parameter_list passable_args_from_parameter_list );
 
+=head1 NAME
+
+Parrot::Pmc2c::Method
+
+=head1 DESCRIPTION
+
+Functions used in transformation of PMCs to C code.
+
+=head1 METHODS
+
+=head2 C<new()>
+
+Parrot::Pmc2c::Method constructor.
+
+=cut
+
 sub new {
     my ( $class, $self_hash ) = @_;
     my $self = {
@@ -89,7 +105,7 @@
     return $self->{pmc_unused};
 }
 
-=head1 C<trans($type)>
+=head2 C<trans($type)>
 
 Used in C<signature()> to normalize argument types.
 
@@ -111,7 +127,7 @@
     return '?';
 }
 
-=head1 C<signature()>
+=head2 C<signature()>
 
 Returns the method signature for the methods $parameters
 
@@ -149,7 +165,7 @@
     return ( $return_prefix, $method_suffix, $args, $sig, $return_type_char, $null_return );
 }
 
-=head1 C<pcc_signature()>
+=head2 C<pcc_signature()>
 
 Returns a PCC-style method signature for the method's parameters, as well as
 some additional information useful in building a call to that method.
@@ -184,6 +200,16 @@
     return ( $sig, $args, $result_decl, $return_stmt );
 }
 
+=head1 SEE ALSO
+
+    lib/Parrot/Pmc2c/PMC/RO.pm
+    lib/Parrot/Pmc2c/PMCEmitter.pm
+    lib/Parrot/Pmc2c/VTable.pm
+    lib/Parrot/Pmc2c/PMC.pm
+    lib/Parrot/Pmc2c/Parser.pm
+
+=cut
+
 1;
 
 # Local Variables:

Modified: trunk/lib/Parrot/Pmc2c/Object.pm
==============================================================================
--- trunk/lib/Parrot/Pmc2c/Object.pm	Sun Nov 22 03:57:16 2009	(r42782)
+++ trunk/lib/Parrot/Pmc2c/Object.pm	Sun Nov 22 04:18:46 2009	(r42783)
@@ -7,6 +7,16 @@
 use strict;
 use warnings;
 
+=head1 NAME
+
+Parrot::Pmc2c::Object
+
+=head1 DESCRIPTION
+
+Functions used in transformation of PMCs to C code.
+
+=head1 METHODS
+
 =over 4
 
 =item C<implements($method)>

Modified: trunk/lib/Parrot/Pmc2c/PMC/Null.pm
==============================================================================
--- trunk/lib/Parrot/Pmc2c/PMC/Null.pm	Sun Nov 22 03:57:16 2009	(r42782)
+++ trunk/lib/Parrot/Pmc2c/PMC/Null.pm	Sun Nov 22 04:18:46 2009	(r42783)
@@ -1,17 +1,21 @@
 # Copyright (C) 2007-2008, Parrot Foundation.
 # $Id$
 
-=head1 Parrot::Pmc2c::Null Instance Methods
-
-=over 4
-
-=cut
-
 package Parrot::Pmc2c::PMC::Null;
 use base 'Parrot::Pmc2c::PMC';
 use strict;
 use warnings;
 
+=head1 NAME
+
+Parrot::Pmc2c::PMC::Null
+
+=head1 DESCRIPTION
+
+PMC to C Instance Methods
+
+=over 4
+
 =item C<pre_method_gen($method, $line, $out_name)>
 
 Auto generates methods for the NULL PMC.

Modified: trunk/lib/Parrot/Pmc2c/PMC/Object.pm
==============================================================================
--- trunk/lib/Parrot/Pmc2c/PMC/Object.pm	Sun Nov 22 03:57:16 2009	(r42782)
+++ trunk/lib/Parrot/Pmc2c/PMC/Object.pm	Sun Nov 22 04:18:46 2009	(r42783)
@@ -7,7 +7,17 @@
 use strict;
 use warnings;
 
-=head1 C<body($method, $line, $out_name)>
+=head1 NAME
+
+Parrot::Pmc2c::PMC::Object
+
+=head1 DESCRIPTION
+
+PMC to C Methods
+
+=head1 METHODS
+
+=head2 C<body($method, $line, $out_name)>
 
 Returns the C code for the method body.
 

Modified: trunk/lib/Parrot/Pmc2c/PMC/ParrotClass.pm
==============================================================================
--- trunk/lib/Parrot/Pmc2c/PMC/ParrotClass.pm	Sun Nov 22 03:57:16 2009	(r42782)
+++ trunk/lib/Parrot/Pmc2c/PMC/ParrotClass.pm	Sun Nov 22 04:18:46 2009	(r42783)
@@ -1,7 +1,15 @@
 # Copyright (C) 2007, Parrot Foundation.
 # $Id$
 
-=head1 Parrot::Pmc2c::ParrotClass Instance Methods
+=head1 NAME
+
+Parrot::Pmc2c::ParrotClass
+
+=head1 DESCRIPTION
+
+Instance Methods
+
+=head1 METHODS
 
 =over 4
 
@@ -19,6 +27,8 @@
 @dont_delegate which should fall through to the default.pmc
 implementation.
 
+=back
+
 =cut
 
 our @dont_delegate = qw(

Modified: trunk/lib/Parrot/Pmc2c/PMC/default.pm
==============================================================================
--- trunk/lib/Parrot/Pmc2c/PMC/default.pm	Sun Nov 22 03:57:16 2009	(r42782)
+++ trunk/lib/Parrot/Pmc2c/PMC/default.pm	Sun Nov 22 04:18:46 2009	(r42783)
@@ -1,7 +1,15 @@
 # Copyright (C) 2007-2008, Parrot Foundation.
 # $Id$
 
-=head1 Parrot::Pmc2c::PMC::default Instance Methods
+=head1 NAME
+
+Parrot::Pmc2c::PMC::default
+
+=head1 DESCRIPTION
+
+Instance Methods
+
+=head1 METHODS
 
 =over 4
 
@@ -17,6 +25,8 @@
 
 Always true.
 
+=back
+
 =cut
 
 sub pre_method_gen {

Modified: trunk/lib/Parrot/Pmc2c/UtilFunctions.pm
==============================================================================
--- trunk/lib/Parrot/Pmc2c/UtilFunctions.pm	Sun Nov 22 03:57:16 2009	(r42782)
+++ trunk/lib/Parrot/Pmc2c/UtilFunctions.pm	Sun Nov 22 04:18:46 2009	(r42783)
@@ -14,6 +14,17 @@
     passable_args_from_parameter_list
 );
 
+=head1 NAME
+
+Parrot::Pmc2c::UtilFunctions
+
+=head1 DESCRIPTION
+
+Various utility functions used in PMC to C transformations.  All functionas
+are exported on request only.
+
+=head1 SUBROUTINES
+
 =over 4
 
 =item C<passable_args_from_parameter_list( $parms )>


More information about the parrot-commits mailing list