From 79954d33e46ff1cdea7ab8044727b521e0a634ce Mon Sep 17 00:00:00 2001 From: Tad Keller <43346260+GLMONTER@users.noreply.github.com> Date: Fri, 16 Aug 2024 03:05:01 -0500 Subject: [PATCH] use new module macros in docs (#2100) Co-authored-by: Tad Keller --- docs/writingmodules.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/writingmodules.rst b/docs/writingmodules.rst index 6baa26794f..032fb0e874 100644 --- a/docs/writingmodules.rst +++ b/docs/writingmodules.rst @@ -974,9 +974,9 @@ to the module's variables, or additional data stored in the ``data`` field of ``YR_OBJECT`` structures as discussed earlier in :ref:`storing-data-for-later-use`. But for that we need a way to get access to the corresponding ``YR_OBJECT`` first. There are two functions to do that: -``module()`` and ``parent()``. The ``module()`` function returns a pointer to +``yr_module()`` and ``yr_parent()``. The ``yr_module()`` function returns a pointer to the top-level ``YR_OBJECT`` corresponding to the module, the same one passed -to the ``module_load`` function. The ``parent()`` function returns a pointer to +to the ``module_load`` function. The ``yr_parent()`` function returns a pointer to the ``YR_OBJECT`` corresponding to the structure where the function is contained. For example, consider the following code snippet: @@ -984,16 +984,16 @@ contained. For example, consider the following code snippet: define_function(f1) { - YR_OBJECT* module = module(); - YR_OBJECT* parent = parent(); + YR_OBJECT* module = yr_module(); + YR_OBJECT* parent = yr_parent(); // parent == module; } define_function(f2) { - YR_OBJECT* module = module(); - YR_OBJECT* parent = parent(); + YR_OBJECT* module = yr_module(); + YR_OBJECT* parent = yr_parent(); // parent != module; } @@ -1026,4 +1026,4 @@ you get a pointer to the ``YR_SCAN_CONTEXT`` structure: .. code-block:: c - YR_SCAN_CONTEXT* context = scan_context(); + YR_SCAN_CONTEXT* context = yr_scan_context();