EU::Typemaps: Document special typemap variables

For better or for worse, these are likely to stay. Don't cry if they
don't.

1 files changed, 20 insertions, 2 deletions

diff --git a/dist/ExtUtils-ParseXS/lib/ExtUtils/ParseXS/Eval.pm b/dist/ExtUtils-ParseXS/lib/ExtUtils/ParseXS/Eval.pm
index e6eee7b8bc..06a7928717 100644
--- a/dist/ExtUtils-ParseXS/lib/ExtUtils/ParseXS/Eval.pm
+++ b/dist/ExtUtils-ParseXS/lib/ExtUtils/ParseXS/Eval.pm
@@ -17,7 +17,7 @@ ExtUtils::ParseXS::Eval - Clean package to evaluate code in
 
 =head1 SUBROUTINES
 
-=head2 eval_output_typemap_code
+=head2 $pxs->eval_output_typemap_code($typemapcode, $other_hashref)
 
 Sets up various bits of previously global state
 (formerly ExtUtils::ParseXS package variables)
@@ -26,6 +26,15 @@ variables.
 
 Warns the contents of C<$@> if any.
 
+Not all these variables are necessarily considered "public" wrt. use in
+typemaps, so beware. Variables set up from the ExtUtils::ParseXS object:
+
+  $Package $Alias $func_name $Full_func_name $pname
+
+Variables set up from C<$other_hashref>:
+
+  $var $type $ntype $subtype $arg
+
 =cut
 
 sub eval_output_typemap_code {
@@ -42,7 +51,7 @@ sub eval_output_typemap_code {
   return $rv;
 }
 
-=head2 eval_input_typemap_code
+=head2 $pxs->eval_input_typemap_code($typemapcode, $other_hashref)
 
 Sets up various bits of previously global state
 (formerly ExtUtils::ParseXS package variables)
@@ -51,6 +60,15 @@ variables.
 
 Warns the contents of C<$@> if any.
 
+Not all these variables are necessarily considered "public" wrt. use in
+typemaps, so beware. Variables set up from the ExtUtils::ParseXS object:
+
+  $Package $Alias $func_name $Full_func_name $pname
+
+Variables set up from C<$other_hashref>:
+
+  $var $type $ntype $subtype $num $init $printed_name $arg $argoff
+
 =cut
 
 sub eval_input_typemap_code {