Skip to content

Commit 48b0995

Browse files
committed
ParseXS: process_typemaps(): update docs
Make them a bit clearer.
1 parent e90f186 commit 48b0995

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

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

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -226,18 +226,21 @@ sub valid_proto_string {
226226
227227
=item * Purpose
228228
229-
Process all typemap files.
229+
Process all typemap files. Reads in any typemap files specified explicitly
230+
with C<-typemap> switches or similar, plus any typemap files found in
231+
standard locations relative to C<@INC> and the current directory.
230232
231233
=item * Arguments
232234
233235
my $typemaps_object = process_typemaps( $args{typemap}, $pwd );
234236
235-
List of two elements: C<typemap> element from C<%args>; current working
236-
directory.
237+
The first argument is the C<typemap> element from C<%args>; the second is
238+
the current working directory (which is only needed for error messages).
237239
238240
=item * Return Value
239241
240-
Upon success, returns an L<ExtUtils::Typemaps> object.
242+
Upon success, returns an L<ExtUtils::Typemaps> object which contains the
243+
accumulated results of all processed typemap files.
241244
242245
=back
243246

0 commit comments

Comments
 (0)