From: cuz <cuz@b7a2c559-68d2-44c3-8de9-860c34a00d81>
Date: Mon, 21 Feb 2005 18:38:17 +0000 (+0000)
Subject: Doc for new comment attribute
X-Git-Tag: V2.12.0~438
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=0566c8a1e27a96d1cc06f7b70aeab870692da058;p=cc65

Doc for new comment attribute


git-svn-id: svn://svn.cc65.org/cc65/trunk@3400 b7a2c559-68d2-44c3-8de9-860c34a00d81
---

diff --git a/doc/da65.sgml b/doc/da65.sgml
index 153ce8573..5c611ee81 100644
--- a/doc/da65.sgml
+++ b/doc/da65.sgml
@@ -313,6 +313,11 @@ following attributes are recognized:
 
 <descrip>
 
+  <tag><tt>COMMENT</tt></tag>
+  This attribute is only allowed if a label is also given. It takes a string
+  as argument. See the description of the <tt><ref id="infofile-label"
+  name="LABEL"></tt> directive for an explanation.
+
   <tag><tt>END</tt></tag>
   This gives the end address of the range. The end address is inclusive, that
   means, it is part of the range. Of course, it may not be smaller than the
@@ -388,6 +393,20 @@ code. The following attributes are recognized:
   <tag><tt>ADDR</tt></tag>
   Followed by a numerical value. Specifies the value of the label.
 
+  <tag><tt>COMMENT</tt></tag>
+  Attribute argument is a string. The comment will show up in a separate line
+  before the label, if the label is within code or data range, or after the
+  label if it is outside.
+
+  Example output:
+
+<tscreen><verb>
+        foo     := $0001        ; Comment for label named "foo"
+
+        ; Comment for label named "bar"
+        bar:
+</verb></tscreen>
+
   <tag><tt>NAME</tt></tag>
   The attribute is followed by a string value which gives the name of the
   label.