[svn:parrot] r42778 - in trunk/src: . pmc runcore

[jkeenan at svn.parrot.org]

Author: jkeenan
Date: Sun Nov 22 03:21:21 2009
New Revision: 42778
URL: https://trac.parrot.org/parrot/changeset/42778

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

Modified:
   trunk/src/global.c
   trunk/src/packfile.c
   trunk/src/parrot_debugger.c
   trunk/src/pmc.c
   trunk/src/pmc/orderedhashiterator.pmc
   trunk/src/pmc/pccmethod_test.pmc
   trunk/src/runcore/cores.c
   trunk/src/runcore/profiling.c
   trunk/src/vtables.c

Modified: trunk/src/global.c
==============================================================================
--- trunk/src/global.c	Sun Nov 22 03:20:20 2009	(r42777)
+++ trunk/src/global.c	Sun Nov 22 03:21:21 2009	(r42778)
@@ -4,11 +4,13 @@
 
 =head1 NAME
 
-src/global.c - Access to global PMCs
+src/global.c
 
 =head1 DESCRIPTION
 
-=head2 Functions
+Access to global PMCs
+
+=head1 FUNCTIONS
 
 =over 4
 

Modified: trunk/src/packfile.c
==============================================================================
--- trunk/src/packfile.c	Sun Nov 22 03:20:20 2009	(r42777)
+++ trunk/src/packfile.c	Sun Nov 22 03:21:21 2009	(r42778)
@@ -10,14 +10,14 @@
 
 =head1 DESCRIPTION
 
-=head2 PackFile Manipulation Functions
-
 This file contains all the functions required for the processing of the
 structure of a PackFile. It is not intended to understand the byte code
 stream itself, but merely to dissect and reconstruct data from the
 various segments. See F<docs/pdds/pdd13_bytecode.pod> for information
 about the structure of the frozen bytecode.
 
+=head2 PackFile Manipulation Functions
+
 =over 4
 
 =cut

Modified: trunk/src/parrot_debugger.c
==============================================================================
--- trunk/src/parrot_debugger.c	Sun Nov 22 03:20:20 2009	(r42777)
+++ trunk/src/parrot_debugger.c	Sun Nov 22 03:21:21 2009	(r42778)
@@ -2,21 +2,20 @@
 Copyright (C) 2001-2009, Parrot Foundation.
 $Id$
 
-History:
-    Renamed from pdb.c in 2008.7.15
-
 =head1 NAME
 
-parrot_debugger - The Parrot debugger
+parrot_debugger
 
-=head1 SYNOPSIS
+=head1 DESCRIPTION
 
- parrot_debugger programfile
- parrot_debugger --script scriptfile programfile
+The Parrot debugger
 
-=head1 DESCRIPTION
+=head1 SYNOPSIS
 
-=head2 Commands
+    parrot_debugger programfile
+    parrot_debugger --script scriptfile programfile
+
+=head1 COMMANDS
 
 =over 4
 
@@ -362,6 +361,10 @@
 
 =back
 
+=head1 HISTORY
+
+Renamed from F<pdb.c> on 2008.7.15
+
 =cut
 
 */

Modified: trunk/src/pmc.c
==============================================================================
--- trunk/src/pmc.c	Sun Nov 22 03:20:20 2009	(r42777)
+++ trunk/src/pmc.c	Sun Nov 22 03:21:21 2009	(r42778)
@@ -4,11 +4,13 @@
 
 =head1 NAME
 
-src/pmc.c - The base vtable calling functions
+src/pmc.c
 
 =head1 DESCRIPTION
 
-=head2 Functions
+The base vtable calling functions
+
+=head1 FUNCTIONS
 
 =over 4
 

Modified: trunk/src/pmc/orderedhashiterator.pmc
==============================================================================
--- trunk/src/pmc/orderedhashiterator.pmc	Sun Nov 22 03:20:20 2009	(r42777)
+++ trunk/src/pmc/orderedhashiterator.pmc	Sun Nov 22 03:21:21 2009	(r42778)
@@ -4,13 +4,13 @@
 
 =head1 NAME
 
-src/pmc/orderedhashiterator.pmc - Implementation of Iterator for OrderedHash.
+src/pmc/orderedhashiterator.pmc
 
 =head1 DESCRIPTION
 
-=head1 SYNOPSIS
+Implementation of Iterator for OrderedHash.
 
-=head1 Methods
+=head1 METHODS
 
 =over 4
 
@@ -114,6 +114,7 @@
 Returns this Iterator's Hash.
 
 =cut
+
 */
     VTABLE PMC* get_pmc() {
         return PARROT_ORDEREDHASHITERATOR(SELF)->pmc_hash;

Modified: trunk/src/pmc/pccmethod_test.pmc
==============================================================================
--- trunk/src/pmc/pccmethod_test.pmc	Sun Nov 22 03:20:20 2009	(r42777)
+++ trunk/src/pmc/pccmethod_test.pmc	Sun Nov 22 03:21:21 2009	(r42778)
@@ -4,7 +4,11 @@
 
 =head1 NAME
 
-src/pmc/pmethod_test.pmc - METHOD_Test PMC
+src/pmc/pmethod_test.pmc
+
+=head1 DESCRIPTION
+
+METHOD_Test PMC
 
 =cut
 

Modified: trunk/src/runcore/cores.c
==============================================================================
--- trunk/src/runcore/cores.c	Sun Nov 22 03:20:20 2009	(r42777)
+++ trunk/src/runcore/cores.c	Sun Nov 22 03:21:21 2009	(r42778)
@@ -2,7 +2,11 @@
 Copyright (C) 2001-2009, Parrot Foundation.
 $Id$
 
-=head1 Run Cores
+=head1 NAME
+
+src/runcore/cores.c - Parrot's execution runcores
+
+=head1 DESCRIPTION
 
 During execution, the runcore is like the heart of Parrot. The runcore
 controls calling the various opcodes with the correct data, and making

Modified: trunk/src/runcore/profiling.c
==============================================================================
--- trunk/src/runcore/profiling.c	Sun Nov 22 03:20:20 2009	(r42777)
+++ trunk/src/runcore/profiling.c	Sun Nov 22 03:21:21 2009	(r42778)
@@ -2,6 +2,14 @@
 Copyright (C) 2009, Parrot Foundation.
 $Id$
 
+=head1 NAME
+
+src/runcore/profiling.c
+
+=head1 DESCRIPTION
+
+Functions controlling Parrot's profiling runcore.
+
 =head2 Functions
 
 =over 4

Modified: trunk/src/vtables.c
==============================================================================
--- trunk/src/vtables.c	Sun Nov 22 03:20:20 2009	(r42777)
+++ trunk/src/vtables.c	Sun Nov 22 03:21:21 2009	(r42778)
@@ -4,10 +4,12 @@
 
 =head1 NAME
 
-src/vtables.c - Functions to build and manipulate vtables
+src/vtables.c
 
 =head1 DESCRIPTION
 
+Functions to build and manipulate vtables
+
 =head2 Functions
 
 =over 4