[svn:parrot] r40062 - branches/ops_pct/compilers/opsc/ops

[bacek at svn.parrot.org]

Author: bacek
Date: Mon Jul 13 22:06:27 2009
New Revision: 40062
URL: https://trac.parrot.org/parrot/changeset/40062

Log:
[opsc] Add little bit more docs to Ops::OpLib

Modified:
   branches/ops_pct/compilers/opsc/ops/oplib.pm

Modified: branches/ops_pct/compilers/opsc/ops/oplib.pm
==============================================================================
--- branches/ops_pct/compilers/opsc/ops/oplib.pm	Mon Jul 13 20:40:15 2009	(r40061)
+++ branches/ops_pct/compilers/opsc/ops/oplib.pm	Mon Jul 13 22:06:27 2009	(r40062)
@@ -16,7 +16,11 @@
 
 =head1 SYNOPSIS
 
-  my $oplib := Ops::OpLib.new.BUILD;
+    my $oplib := Ops::OpLib.new.BUILD(
+        :files(@files),
+        :num_file('../../src/ops/ops.num'),
+        :skip_file('../../src/ops/ops.skip'),
+    ));
 
 =head1 ATTRIBUTES
 
@@ -26,6 +30,12 @@
 
 Op files. Mandatory argument of C<BUILD> method.
 
+=item * C<@.ops>
+
+List of parsed ops. Currently as C<PAST::Block>, but we probably will use
+more specific class inherited from C<PAST::Block> to provide some helper
+methods.
+
 =item * C<$.max_op_num>
 
 Scalar holding number of highest non-experimental op.  Example:
@@ -190,6 +200,24 @@
     >;
 }
 
+=head2 ACCESSORS
+
+Various methods for accessing internals.
+
+=over 4
+
+=item * C<ops>
+
+=item * C<files>
+
+=item * C<max_op_num>
+
+=item * C<optable>
+
+=item * C<skiptable>
+
+=cut
+
 method ops() {
     self<ops>;
 }