[docs] Fix pmc NAME

Harmonize public PMC names in pod. Fixes GH #1079. Also do a little bit of PMC description tuning.
parrot · Jun 16, 2014 · f882a4b · f882a4b
1 parent 12bf88e
commit f882a4b
Show file tree

Hide file tree

Showing 74 changed files with 135 additions and 112 deletions.
diff --git a/src/pmc/addrregistry.pmc b/src/pmc/addrregistry.pmc
@@ -3,7 +3,7 @@ Copyright (C) 2005-2014, Parrot Foundation.
 
 =head1 NAME
 
-src/pmc/addrregistry.pmc - A GC Registry PMC
+src/pmc/addrregistry.pmc - AddrRegistry PMC
 
 =head1 DESCRIPTION
 

diff --git a/src/pmc/alarm.pmc b/src/pmc/alarm.pmc
@@ -3,7 +3,7 @@ Copyright (C) 2001-2014, Parrot Foundation.
 
 =head1 NAME
 
-src/pmc/alarm.pmc - Alarm
+src/pmc/alarm.pmc - Alarm PMC
 
 =head1 SYNOPSIS
 

diff --git a/src/pmc/arrayiterator.pmc b/src/pmc/arrayiterator.pmc
@@ -3,7 +3,7 @@ Copyright (C) 2001-2014, Parrot Foundation.
 
 =head1 NAME
 
-src/pmc/arrayiterator.pmc - Implementation of Iterator for Arrays.
+src/pmc/arrayiterator.pmc - ArrayIterator PMC
 
 =head1 DESCRIPTION
 

diff --git a/src/pmc/bigint.pmc b/src/pmc/bigint.pmc
@@ -3,7 +3,7 @@ Copyright (C) 2004-2014, Parrot Foundation.
 
 =head1 NAME
 
-src/pmc/bigint.pmc - BigInt PMC class
+src/pmc/bigint.pmc - BigInt PMC
 
 =head1 DESCRIPTION
 

diff --git a/src/pmc/bignum.pmc b/src/pmc/bignum.pmc
@@ -3,7 +3,7 @@ Copyright (C) 2004-2014, Parrot Foundation.
 
 =head1 NAME
 
-src/pmc/bignum.pmc - BigNum PMC class
+src/pmc/bignum.pmc - BigNum PMC
 
 =head1 DESCRIPTION
 

diff --git a/src/pmc/bytebuffer.pmc b/src/pmc/bytebuffer.pmc
@@ -3,7 +3,7 @@ Copyright (C) 2010-2014, Parrot Foundation.
 
 =head1 NAME
 
-src/pmc/bytebuffer.pmc - A byte buffer
+src/pmc/bytebuffer.pmc - ByteBuffer PMC
 
 =head1 DESCRIPTION
 

diff --git a/src/pmc/callback.pmc b/src/pmc/callback.pmc
@@ -3,7 +3,7 @@ Copyright (C) 2010-2014, Parrot Foundation.
 
 =head1 NAME
 
-src/pmc/callback.pmc - Callback
+src/pmc/callback.pmc - Callback PMC
 
 =head1 DESCRIPTION
 

diff --git a/src/pmc/class.pmc b/src/pmc/class.pmc
@@ -3,7 +3,7 @@ Copyright (C) 2001-2014, Parrot Foundation.
 
 =head1 NAME
 
-src/pmc/class.pmc - defines a class
+src/pmc/class.pmc - Class PMC
 
 =head1 DESCRIPTION
 

diff --git a/src/pmc/complex.pmc b/src/pmc/complex.pmc
@@ -3,7 +3,7 @@ Copyright (C) 2004-2014, Parrot Foundation.
 
 =head1 NAME
 
-src/pmc/complex.pmc - Complex Numbers PMC Class
+src/pmc/complex.pmc - Complex PMC
 
 =head1 DESCRIPTION
 
@@ -13,7 +13,7 @@ string parsing/generating and basic mathematical operations.
 =head2 Functions
 
 Equations used are sometimes listed.  At times, multiple equations are given,
-but those starting with => are the ones used
+but those starting with => are the ones used.
 
 =over 4
 

diff --git a/src/pmc/coroutine.pmc b/src/pmc/coroutine.pmc
@@ -3,7 +3,7 @@ Copyright (C) 2001-2014, Parrot Foundation.
 
 =head1 NAME
 
-src/pmc/coroutine.pmc - Co-Routine PMC
+src/pmc/coroutine.pmc - Coroutine PMC
 
 =head1 DESCRIPTION
 

diff --git a/src/pmc/default.pmc b/src/pmc/default.pmc
@@ -3,11 +3,12 @@ Copyright (C) 2001-2014, Parrot Foundation.
 
 =head1 NAME
 
-src/pmc/default.pmc - Abstract root class
+src/pmc/default.pmc - default PMC
 
 =head1 DESCRIPTION
 
-These are the vtable functions for the default PMC class.
+These are the vtable functions for the default PMC class, the abstract
+root class.
 
 All methods which are not defined here get a default implementation
 generated from F<src/vtable.tbl> by F<tools/build/pmc2c.pl>.

diff --git a/src/pmc/env.pmc b/src/pmc/env.pmc
@@ -3,7 +3,7 @@ Copyright (C) 2001-2014, Parrot Foundation.
 
 =head1 NAME
 
-src/pmc/env.pmc - System Environment
+src/pmc/env.pmc - Env PMC
 
 =head1 DESCRIPTION
 

diff --git a/src/pmc/eventhandler.pmc b/src/pmc/eventhandler.pmc
@@ -3,7 +3,7 @@ Copyright (C) 2007-2014, Parrot Foundation.
 
 =head1 NAME
 
-src/pmc/eventhandler.pmc - a handler for events
+src/pmc/eventhandler.pmc - EventHandler PMC
 
 =head1 DESCRIPTION
 

diff --git a/src/pmc/exceptionhandler.pmc b/src/pmc/exceptionhandler.pmc
@@ -3,7 +3,7 @@ Copyright (C) 2001-2014, Parrot Foundation.
 
 =head1 NAME
 
-src/pmc/exceptionhandler.pmc - Exception Handler PMC
+src/pmc/exceptionhandler.pmc - ExceptionHandler PMC
 
 =head1 DESCRIPTION
 

diff --git a/src/pmc/exporter.pmc b/src/pmc/exporter.pmc
@@ -3,10 +3,12 @@ Copyright (C) 2007-2009, Parrot Foundation.
 
 =head1 NAME
 
-src/pmc/exporter.pmc - Export globals from one namespace to another
+src/pmc/exporter.pmc - Exporter PMC
 
 =head1 SYNOPSIS
 
+Export globals from one namespace to another.
+
 You can use Exporter in PIR to import subs from a library. At its simplest:
 
  .sub main :main

diff --git a/src/pmc/fixedbooleanarray.pmc b/src/pmc/fixedbooleanarray.pmc
@@ -3,10 +3,12 @@ Copyright (C) 2001-2014, Parrot Foundation.
 
 =head1 NAME
 
-src/pmc/fixedbooleanarray.pmc - fixed size array for booleans only
+src/pmc/fixedbooleanarray.pmc - FixedBooleanArray PMC
 
 =head1 DESCRIPTION
 
+Fixed size array for booleans only.
+
 The C<FixedBooleanArray> PMC implements an array of fixed size, which
 stores booleans.  It uses the C<Boolean> PMC for all conversions.  The
 C<FixedBooleanArray> PMC is extended by the C<ResizableBooleanArray>

diff --git a/src/pmc/fixedfloatarray.pmc b/src/pmc/fixedfloatarray.pmc
@@ -3,10 +3,12 @@ Copyright (C) 2001-2014, Parrot Foundation.
 
 =head1 NAME
 
-src/pmc/fixedfloatarray.pmc - fixed size array for floating point numbers only
+src/pmc/fixedfloatarray.pmc - FixedFloatArray PMC
 
 =head1 DESCRIPTION
 
+Fixed size array for floating point numbers only.
+
 This class, FixedFloatArray, implements an array of fixed size which
 stores FLOATVALs.  It uses Float PMCs to do all necessary conversions.
 

diff --git a/src/pmc/fixedintegerarray.pmc b/src/pmc/fixedintegerarray.pmc
@@ -3,10 +3,12 @@ Copyright (C) 2001-2014, Parrot Foundation.
 
 =head1 NAME
 
-src/pmc/fixedintegerarray.pmc - fixed size array for integers only
+src/pmc/fixedintegerarray.pmc - FixedIntegerArray PMC
 
 =head1 DESCRIPTION
 
+Fixed size array for integers only.
+
 This class, FixedIntegerArray, implements an array of fixed size which stores
 INTVALs.  It uses Integer PMCs for all of the conversions.
 

diff --git a/src/pmc/fixedpmcarray.pmc b/src/pmc/fixedpmcarray.pmc
@@ -3,12 +3,14 @@ Copyright (C) 2001-2014, Parrot Foundation.
 
 =head1 NAME
 
-src/pmc/fixedpmcarray.pmc - fixed size array for PMCs only
+src/pmc/fixedpmcarray.pmc - FixedPMCArray PMC
 
 =head1 DESCRIPTION
 
+Fixed size array for PMCs only.
+
 This class, FixedPMCArray, implements an array of fixed size which stores PMCs.
-It puts things into Integer, Float, or String PMCs as appropriate
+It puts things into Integer, Float, or String PMCs as appropriate.
 
 =head2 Note
 

diff --git a/src/pmc/fixedstringarray.pmc b/src/pmc/fixedstringarray.pmc
@@ -3,10 +3,12 @@ Copyright (C) 2001-2014, Parrot Foundation.
 
 =head1 NAME
 
-src/pmc/fixedstringarray.pmc - fixed size array for strings only
+src/pmc/fixedstringarray.pmc - FixedStringArray PMC
 
 =head1 DESCRIPTION
 
+Fixed size array for strings only.
+
 This class, FixedStringArray, implements an array of fixed size which
 stores Parrot strings.
 

diff --git a/src/pmc/float.pmc b/src/pmc/float.pmc
@@ -3,7 +3,7 @@ Copyright (C) 2003-2014, Parrot Foundation.
 
 =head1 NAME
 
-src/pmc/float.pmc - Floating-point number
+src/pmc/float.pmc - Float PMC
 
 =head1 DESCRIPTION
 

diff --git a/src/pmc/handle.pmc b/src/pmc/handle.pmc
@@ -3,7 +3,7 @@ Copyright (C) 2008-2014, Parrot Foundation.
 
 =head1 NAME
 
-src/pmc/handle.pmc - IO Handle PMC
+src/pmc/handle.pmc - Handle PMC
 
 =head1 DESCRIPTION
 

diff --git a/src/pmc/hashiterator.pmc b/src/pmc/hashiterator.pmc
@@ -3,11 +3,11 @@ Copyright (C) 2001-2014, Parrot Foundation.
 
 =head1 NAME
 
-src/pmc/hashiterator.pmc - Implementation of Iterator for Hashes.
+src/pmc/hashiterator.pmc - HashIterator PMC
 
 =head1 DESCRIPTION
 
-Generic iterator for traversing Hash.
+Generic iterator for traversing a Hash PMC.
 
 =head1 SYNOPSIS
 

diff --git a/src/pmc/hashiteratorkey.pmc b/src/pmc/hashiteratorkey.pmc
@@ -3,12 +3,11 @@ Copyright (C) 2001-2014, Parrot Foundation.
 
 =head1 NAME
 
-src/pmc/hashiteratorkey.pmc - accessor for single value during hash iteration.
+src/pmc/hashiteratorkey.pmc - HashIteratorKey PMC
 
 =head1 DESCRIPTION
 
-Single (key,value) pair.
-
+Accessor for a single value during hash iteration, a single (key,value) pair.
 
 =head1 Methods
 

diff --git a/src/pmc/imageiofreeze.pmc b/src/pmc/imageiofreeze.pmc
@@ -7,7 +7,7 @@ src/pmc/imageiofreeze.pmc - ImageIOFreeze PMC
 
 =head1 DESCRIPTION
 
-Freezes other PMCs.
+Freezes other PMCs. Part of the internal serializer.
 
 =head1 FUNCTIONS
 

diff --git a/src/pmc/imageiosize.pmc b/src/pmc/imageiosize.pmc
@@ -8,6 +8,7 @@ src/pmc/imageiosize.pmc - ImageIOSize PMC
 =head1 DESCRIPTION
 
 Gets the size of an ImageIO image without the allocation costs.
+Part of the internal serializer.
 
 =head1 STATIC FUNCTIONS
 

diff --git a/src/pmc/imageiostrings.pmc b/src/pmc/imageiostrings.pmc
@@ -3,7 +3,7 @@ Copyright (C) 2010-2014, Parrot Foundation.
 
 =head1 NAME
 
-src/pmc/imageiosize.pmc - ImageIOStrings PMC
+src/pmc/imageiostrings.pmc - ImageIOStrings PMC
 
 =head1 DESCRIPTION
 

diff --git a/src/pmc/imccompiler.pmc b/src/pmc/imccompiler.pmc
@@ -3,11 +3,11 @@ Copyright (C) 2011-2014, Parrot Foundation.
 
 =head1 NAME
 
-src/pmc/imccompiler.pmc - A compiler object to wrap IMCC
+src/pmc/imccompiler.pmc - IMCCompiler PMC
 
 =head1 DESCRIPTION
 
-A compiler object to wrap IMCC
+A compiler object to wrap IMCC, the internal PIR and PASM compiler.
 
 =head2 Functions
 

diff --git a/src/pmc/integer.pmc b/src/pmc/integer.pmc
@@ -3,7 +3,7 @@ Copyright (C) 2003-2014, Parrot Foundation.
 
 =head1 NAME
 
-src/pmc/integer.pmc - Integer PMC class
+src/pmc/integer.pmc - Integer PMC
 
 =head1 DESCRIPTION
 

diff --git a/src/pmc/managedstruct.pmc b/src/pmc/managedstruct.pmc
@@ -3,12 +3,13 @@ Copyright (C) 2001-2014, Parrot Foundation.
 
 =head1 NAME
 
-src/pmc/managedstruct.pmc - Memory-managed C struct
+src/pmc/managedstruct.pmc - ManagedStruct PMC
 
 =head1 DESCRIPTION
 
 C<ManagedStruct> extends C<UnManagedStruct> to provide a class to hold C
-C<struct> values that Parrot is responsible for disposing of.
+C<struct> values, a memory-managed C struct, that Parrot is responsible 
+for disposing of.
 
 =head2 Methods
 

diff --git a/src/pmc/mappedbytearray.pmc b/src/pmc/mappedbytearray.pmc
@@ -3,14 +3,14 @@ Copyright (C) 2010-2014, Parrot Foundation.
 
 =head1 NAME
 
-src/pmc/mappedbytearray.pmc - Mapped byte array
+src/pmc/mappedbytearray.pmc - MappedByteArray PMC
 
 =head1 DESCRIPTION
 
 A memory mapped file or shared memory segment accessible as array of bytes.
 
-Bare minimal functionality available, only for posix platforms
-(tested on linux).
+Bare minimal functionality available, currently only for posix platforms
+with <sys/mman.h> available, or on mingw32.
 
 =cut
 
@@ -29,7 +29,7 @@ Bare minimal functionality available, only for posix platforms
 #  ifdef __MINGW32__
 #    define ENABLED
 #    define MAPW32
-#    include<Windows.h>
+#    include <Windows.h>
 #  endif
 #endif
 

diff --git a/src/pmc/multisub.pmc b/src/pmc/multisub.pmc
@@ -3,10 +3,12 @@ Copyright (C) 2001-2014, Parrot Foundation.
 
 =head1 NAME
 
-src/pmc/multisub.pmc - A container for multi-dispatched subs
+src/pmc/multisub.pmc - MultiSub PMC
 
 =head1 DESCRIPTION
 
+A container for multi-dispatched subs.
+
 This class inherits from ResizablePMCArray and provides an Array of
 Sub PMCs with the same short name, but different long names.
 

diff --git a/src/pmc/namespace.pmc b/src/pmc/namespace.pmc
@@ -7,7 +7,8 @@ src/pmc/namespace.pmc - NameSpace PMC
 
 =head1 DESCRIPTION
 
-These are the vtable functions for the namespace PMC.
+These are the vtable functions for the namespace PMC, 
+a container for dynamic and structured variable lookup.
 
 =head2 Functions