Document gv_stashsvpvn_cached

1 files changed, 10 insertions, 4 deletions

diff --git a/gv.c b/gv.c
index 0795b7966d..861f65c237 100644
--- a/gv.c
+++ b/gv.c
@@ -1543,17 +1543,23 @@ S_gv_stashpvn_internal(pTHX_ const char *name, U32 namelen, I32 flags)
 }
 
 /*
-gv_stashsvpvn_cached
+=for apidoc gv_stashsvpvn_cached
 
 Returns a pointer to the stash for a specified package, possibly
-cached.  Implements both C<L</gv_stashpvn>> and C<L</gv_stashsv>>.
+cached.  Implements both L<perlapi/C<gv_stashpvn>> and
+L<perlapi/C<gv_stashsv>>.
 
 Requires one of either C<namesv> or C<namepv> to be non-null.
 
-See C<L</gv_stashpvn>> for details on C<flags>.
+If the flag C<GV_CACHE_ONLY> is set, return the stash only if found in the
+cache; see L<perlapi/C<gv_stashpvn>> for details on the other C<flags>.
 
-Note the sv interface is strongly preferred for performance reasons.
+Note it is strongly preferred for C<namesv> to be non-null, for performance
+reasons.
+
+=for apidoc Emnh||GV_CACHE_ONLY
 
+=cut
 */
 
 #define PERL_ARGS_ASSERT_GV_STASHSVPVN_CACHED \