Mark internal and document my_cxt_init

1 files changed, 12 insertions, 6 deletions

diff --git a/util.c b/util.c
index 8a5d288626..6e1faed64a 100644
--- a/util.c
+++ b/util.c
@@ -5591,13 +5591,19 @@ Perl_my_clearenv(pTHX)
 
 #ifdef MULTIPLICITY
 
+/*
+=for apidoc my_cxt_init
+
+Implements the L<perlxs/C<MY_CXT_INIT>> macro, which you should use instead.
+
+The first time a module is loaded, the global C<PL_my_cxt_index> is incremented,
+and that value is assigned to that module's static C<my_cxt_index> (whose
+address is passed as an arg).  Then, for each interpreter this function is
+called for, it makes sure a C<void*> slot is available to hang the static data
+off, by allocating or extending the interpreter's C<PL_my_cxt_list> array
 
-/* Implements the MY_CXT_INIT macro. The first time a module is loaded,
-the global PL_my_cxt_index is incremented, and that value is assigned to
-that module's static my_cxt_index (who's address is passed as an arg).
-Then, for each interpreter this function is called for, it makes sure a
-void* slot is available to hang the static data off, by allocating or
-extending the interpreter's PL_my_cxt_list array */
+=cut
+*/
 
 void *
 Perl_my_cxt_init(pTHX_ int *indexp, size_t size)