Skip to content

Commit 10adb09

Browse files
committed
ParseXS: refactor: fixup some code comments
1 parent 0f6eaf1 commit 10adb09

File tree

1 file changed

+14
-13
lines changed
  • dist/ExtUtils-ParseXS/lib/ExtUtils/ParseXS

1 file changed

+14
-13
lines changed

dist/ExtUtils-ParseXS/lib/ExtUtils/ParseXS/Node.pm

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2121,21 +2121,22 @@ sub as_output_code {
21212121

21222122
package ExtUtils::ParseXS::Node::Params;
21232123

2124-
# Node subclass which holds a list of the parameters for an XSUB
2125-
# (both directly found in the foo(....) signature, plus possibly synthetic
2126-
# ones such as THIS and RETVAL.
2127-
# It is a mainly a list of Node::Param or Node::IO_Param children.
2124+
# A Node subclass which holds a list of the parameters for an XSUB.
2125+
# It is a mainly a list of Node::Param or Node::IO_Param kids, and is
2126+
# used in two contexts.
2127+
#
2128+
# First, as a field of an xsub_decl node, where it holds a list of Param
2129+
# objects which represent the individual parameters found within an XSUB's
2130+
# signature, plus possibly extra synthetic ones such as THIS and RETVAL.
2131+
#
2132+
# Second, as a field of an xbody node, where it contains a copy of the
2133+
# signature's Params object (and Param children), but where the children
2134+
# are in fact IO_param objects and hold augmented information provided by
2135+
# any INPUT and OUTPUT blocks within that XSUB body (of which there can be
2136+
# more than one in the presence of CASE).
21282137

21292138
BEGIN { $build_subclass->(parent => '',
21302139

2131-
# Inherited 'kids' field:
2132-
#
2133-
# Array ref of Node::Param or Node::IO_Param
2134-
# objects representing the parameters of this
2135-
# XSUB - either the original ones as seen in the
2136-
# XSUB's signature, or per-xbody ones augmented
2137-
# by info from INPUT and OUTPUT sections.
2138-
21392140
'names', # Hash ref mapping variable names to Node::Param
21402141
# or Node::IO_Param objects
21412142

@@ -3018,7 +3019,7 @@ sub parse {
30183019

30193020
$self->SUPER::parse($pxs); # set file/line_no
30203021

3021-
# Repeatedly look for INIT or generic keywords,
3022+
# Repeatedly look for CLEANUP or generic keywords,
30223023
# parse the text following them, and add any resultant nodes
30233024
# as kids to the current node.
30243025
$self->parse_keywords(

0 commit comments

Comments
 (0)