Document the blockhook functions and macros.

1 files changed, 24 insertions, 0 deletions

diff --git a/op.h b/op.h
index ac34f1d19b..30a41c8edd 100644
--- a/op.h
+++ b/op.h
@@ -653,6 +653,30 @@ struct block_hooks {
     void    (*bhk_eval)		(pTHX_ OP *const saveop);
 };
 
+/*
+=head1 Compile-time scope hooks
+
+=for apidoc m|U32|BhkFLAGS|BHK *hk
+Return the BHK's flags.
+
+=for apidoc m|void *|BhkENTRY|BHK *hk|which
+Return an entry from the BHK structure. I<which> is a preprocessor token
+indicating which entry to return. If the appropriate flag is not set
+this will return NULL. The type of the return value depends on which
+entry you ask for.
+
+=for apidoc Am|void|BhkENTRY_set|BHK *hk|which|void *ptr
+Set an entry in the BHK structure, and set the flags to indicate it is
+valid. I<which> is a preprocessing token indicating which entry to set.
+The type of I<ptr> depends on the entry.
+
+=for apidoc m|void|CALL_BLOCK_HOOKS|which|arg
+Call all the registered block hooks for type I<which>. I<which> is a
+preprocessing token; the type of I<arg> depends on I<which>.
+
+=cut
+*/
+
 #define BhkFLAGS(hk)		((hk)->bhk_flags)
 
 #define BHKf_start	    0x01