Document comment macros

[frida/doc.git] / source / macros.rst

diff --git a/source/macros.rst b/source/macros.rst
new file mode 100644 (file)
index 0000000..fadc0ad
--- /dev/null
+++ b/source/macros.rst
@@ -0,0 +1,12 @@
+Macros
+======
+
+Within comments, a set of Macros is supported which will automatically
+update according to the referenced object's name. All macros start by
+the sequence ``#``, a single-letter type, ``<``, the address and
+finally a ``>``. Currently the following macros are asigned:
+
++------------+----------------------------------------+
+| #F<0x1234> | Name of the function at address 0x1234 |
++------------+----------------------------------------+
+