Document comment macros
authorChristoph Egger <christoph@christoph-egger.org>
Sat, 10 Oct 2015 16:51:44 +0000 (18:51 +0200)
committerChristoph Egger <christoph@christoph-egger.org>
Sat, 10 Oct 2015 17:03:36 +0000 (19:03 +0200)
source/index.rst
source/macros.rst [new file with mode: 0644]

index 647b6f7d319032f92e97335e12eb10fab7afedbe..3596dc8917203a84f38703a41053d77e861a4737 100644 (file)
@@ -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 (file)
index 0000000..fadc0ad
--- /dev/null
@@ -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 |
++------------+----------------------------------------+
+