From: Dave Rolsky <autarch@urth.org> Date: Wed, 3 Sep 2008 15:10:21 +0000 (+0000) Subject: Change the docs so that _most_ functions are marked as not for others' use. X-Git-Tag: 0.66~12 X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=bd07fbdbc2ac02a977db61651f2f85d0d1198ac0;p=gitmo%2FClass-MOP.git Change the docs so that _most_ functions are marked as not for others' use. --- diff --git a/lib/Class/MOP.pm b/lib/Class/MOP.pm index 6b4c569..becce3e 100644 --- a/lib/Class/MOP.pm +++ b/lib/Class/MOP.pm @@ -844,10 +844,7 @@ subclasses of a certain class. =head2 Utility functions -Note that these are all called as B<functions, not methods>. They are -"public" in the sense that they're documented for use by other -Class::MOP and Moose modules, but they're not really intended for use -in end-user code. +Note that these are all called as B<functions, not methods>. =over 4 @@ -869,6 +866,8 @@ is probably correct about 99% of the time. =item B<check_package_cache_flag ($pkg)> +B<NOTE: DO NOT USE THIS FUNCTION, IT IS FOR INTERNAL USE ONLY!> + This will return an integer that is managed by C<Class::MOP::Class> to determine if a module's symbol table has been altered. @@ -878,6 +877,8 @@ which is not package specific. =item B<get_code_info ($code)> +B<NOTE: DO NOT USE THIS FUNCTION, IT IS FOR INTERNAL USE ONLY!> + This function returns two values, the name of the package the C<$code> is from and the name of the C<$code> itself. This is used by several elements of the MOP to detemine where a given C<$code> reference is from. @@ -892,6 +893,8 @@ argument. =item B<in_global_destruction> +B<NOTE: DO NOT USE THIS FUNCTION, IT IS FOR INTERNAL USE ONLY!> + If L<Devel::GlobalDestruction> is available, this returns true under global destruction.