diff options
| author | Paul "LeoNerd" Evans <leonerd@leonerd.org.uk> | 2022-09-14 13:51:15 +0100 |
|---|---|---|
| committer | Yves Orton <demerphq@gmail.com> | 2023-02-08 16:58:32 +0800 |
| commit | efa8f708cd0da7c71bb71920a47b545bd07bc28a (patch) | |
| tree | 35dac76b1b17056bccf287879ba767ee3bcc165d /mro_core.c | |
| parent | bd90fa412bb2eb27ffa23a0e439350a39847521e (diff) | |
| download | perl-efa8f708cd0da7c71bb71920a47b545bd07bc28a.tar.gz | |
pod/perlmroapi.pod - document linear MRO function return type.
Small docs clarification to point out that the linear MRO function returns a
list of strings
Diffstat (limited to 'mro_core.c')
| -rw-r--r-- | mro_core.c | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/mro_core.c b/mro_core.c index 8284fb10a8..f1068314e8 100644 --- a/mro_core.c +++ b/mro_core.c @@ -216,7 +216,8 @@ Perl_mro_meta_dup(pTHX_ struct mro_meta* smeta, CLONE_PARAMS* param) =for apidoc mro_get_linear_isa_dfs Returns the Depth-First Search linearization of C<@ISA> -the given stash. The return value is a read-only AV*. +the given stash. The return value is a read-only AV* +whose elements are string SVs giving class names. C<level> should be 0 (it is used internally in this function's recursion). @@ -399,7 +400,7 @@ S_mro_get_linear_isa_dfs(pTHX_ HV *stash, U32 level) Returns the mro linearisation for the given stash. By default, this will be whatever C<mro_get_linear_isa_dfs> returns unless some other MRO is in effect for the stash. The return value is a -read-only AV*. +read-only AV* whose values are string SVs giving class names. You are responsible for C<SvREFCNT_inc()> on the return value if you plan to store it anywhere |