cvsuser 04/02/19 14:31:43
Modified: classes pmc2c2.pl Log: Minor documentation tweaks Revision Changes Path 1.7 +10 -9 parrot/classes/pmc2c2.pl Index: pmc2c2.pl =================================================================== RCS file: /cvs/public/parrot/classes/pmc2c2.pl,v retrieving revision 1.6 retrieving revision 1.7 diff -u -w -r1.6 -r1.7 --- pmc2c2.pl 20 Jan 2004 22:29:59 -0000 1.6 +++ pmc2c2.pl 19 Feb 2004 22:31:43 -0000 1.7 @@ -1,7 +1,7 @@ #! perl -w ################################################################################ # Copyright: 2001-2003 The Perl Foundation. All Rights Reserved. -# $Id: pmc2c2.pl,v 1.6 2004/01/20 22:29:59 mikescott Exp $ +# $Id: pmc2c2.pl,v 1.7 2004/02/19 22:31:43 scog Exp $ ################################################################################ =head1 NAME @@ -80,8 +80,8 @@ Finally, the .c and .h files are generated. The appropriate base class header files are included. -If the C<noinit> flag was used, then no init function is generated, -otherwise one is generated which sets up the vtable and enters it into +If the C<noinit> flag was used, then no init function is generated. +Otherwise, one is generated which sets up the vtable and enters it into the C<Parrot_base_vtables> array. The .c file is generated by appending the functions after the various @@ -114,7 +114,7 @@ =item C<abstract> -This class can't be instantiated. Abstract classes are shown with lower +This class cannot be instantiated. Abstract classes are shown with lower case class names in the class tree. =item C<noinit> @@ -123,22 +123,23 @@ =item C<dynpmc> -The class is a dynamic classes. These have a special C<class_init> +The class is a dynamic class. These have a special C<class_init> routine suitable for dynamic loading at runtime. See the F<dynclasses> directory for an example. =item C<const_too> -Classes with this flag get 2 vtables and 2 enums, one with r/w set -methods one with r/o set methods. +Classes with this flag get 2 vtables and 2 enums, one pair with +read/write set methods, and one with read-only set methods. =item C<need_ext> -The class needs a C<PMC_EXT> structure (its using e.g. C<PMC_data>). +The class needs a C<PMC_EXT> structure. For instance, any class using +C<PMC_data> will have C<need_ext>. =item C<does interface> -The class does the given interfaces (the collection of methods +The class 'does' the given interfaces (the collection of methods which the class implements). The default is "scalar". Other currently used interfaces are:
