From: Christoph Egger <christoph@christoph-egger.org>
Date: Mon, 25 May 2015 05:47:37 +0000 (+0200)
Subject: Document magic syntax for comments
X-Git-Url: https://git.siccegge.de//index.cgi?p=frida%2Fdoc.git;a=commitdiff_plain;h=7fc73c8c3dec35f500025ec4807a423c161548a5;hp=c366624e44aabcf1d7a6e313f0e03337249647ba

Document magic syntax for comments

Actual implementation still needs to follow! Special comments are
already created but not displayed correctly
---

diff --git a/source/using.rst b/source/using.rst
index e3b4695..0abfa1c 100644
--- a/source/using.rst
+++ b/source/using.rst
@@ -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
 ===============