From 73eb9bb082ca2c0c95e6fcaab6488d88db5e7a67 Mon Sep 17 00:00:00 2001 From: Christoph Egger Date: Sat, 10 Oct 2015 18:51:44 +0200 Subject: [PATCH] Document comment macros --- source/index.rst | 1 + source/macros.rst | 12 ++++++++++++ 2 files changed, 13 insertions(+) create mode 100644 source/macros.rst diff --git a/source/index.rst b/source/index.rst index 647b6f7..3596dc8 100644 --- a/source/index.rst +++ b/source/index.rst @@ -14,6 +14,7 @@ Contents: intro installing using + macros scripting Indices and tables diff --git a/source/macros.rst b/source/macros.rst new file mode 100644 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 | ++------------+----------------------------------------+ + -- 2.39.5