Document magic syntax for comments
authorChristoph Egger <christoph@christoph-egger.org>
Mon, 25 May 2015 05:47:37 +0000 (07:47 +0200)
committerChristoph Egger <christoph@christoph-egger.org>
Mon, 25 May 2015 05:47:37 +0000 (07:47 +0200)
Actual implementation still needs to follow! Special comments are
already created but not displayed correctly

source/using.rst

index e3b46958baf527574d519b73352932c81002bd4a..0abfa1ce8b48729ac9708d68ed0681d534e5e055 100644 (file)
@@ -23,6 +23,11 @@ meaningful only in the context of the specific function but not when
 the same address appears within different functions. However, local
 functions are not completely implemented yet.
 
+Within comments, special placeholders exist. This way functions (and,
+later, other objects cann be referenced in a way that automatically
+updates the displayed string inside the comment. The syntax for a
+function reference is ``#F<0xABCD1234>``.
+
 Saving progress
 ===============