Skip to main content
summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorpelder2008-05-22 11:07:12 -0400
committerpelder2008-05-22 11:07:12 -0400
commit6b47d8b5efddb46a24fd061c71f05fc335d062fe (patch)
tree4d293c7d751becae6ba051b58728d6087008960a /doc/org.eclipse.jet.doc/references/syntax
parent3e99a8f723c17ca6b094c09613ee293f66b29425 (diff)
downloadorg.eclipse.jet-6b47d8b5efddb46a24fd061c71f05fc335d062fe.tar.gz
org.eclipse.jet-6b47d8b5efddb46a24fd061c71f05fc335d062fe.tar.xz
org.eclipse.jet-6b47d8b5efddb46a24fd061c71f05fc335d062fe.zip
[205811] Define a mechanism for including copyright notices in all JET generated Java classes
Diffstat (limited to 'doc/org.eclipse.jet.doc/references/syntax')
-rw-r--r--doc/org.eclipse.jet.doc/references/syntax/jetSyntaxComments.xhtml35
1 files changed, 28 insertions, 7 deletions
diff --git a/doc/org.eclipse.jet.doc/references/syntax/jetSyntaxComments.xhtml b/doc/org.eclipse.jet.doc/references/syntax/jetSyntaxComments.xhtml
index 908905d..b66ee88 100644
--- a/doc/org.eclipse.jet.doc/references/syntax/jetSyntaxComments.xhtml
+++ b/doc/org.eclipse.jet.doc/references/syntax/jetSyntaxComments.xhtml
@@ -16,18 +16,37 @@
<h2>JET Comment Syntax Reference</h2>
<p>JET templates may contain comments between the characters
- <code>&lt;%--</code> and <code>--%&gt;</code>. JET ignores all
- content in a comment. </p>
+ <code>&lt;%--</code> and <code>--%&gt;</code>.
+ Comments have no impact on the execution of the template, except that they may influence
+ whitespace stripping rules.
+ JET comments are copied to the generated Java class as Java line comments. </p>
+ <p>
+ JET templates accept two special tags in the first non-blank line of a comment. The tag '@header' will
+ cause the comment to be emitted as the file header comment for the generated Java class.
+ This can be useful for inserting copyright notices into the generated Java code.
+ The tag '@class' will
+ cause the comment to be emitted as the class Java doc comment for the generated Java class.
+ </p>
<h3>Valid comments</h3>
<p>Comments may span several lines, and may contain any text. The
following are examples of a JET comments:</p>
- <pre>&lt;%-- This comment will not appear in the template output --%&gt;
-&lt;%-- This directive is not used
-&lt;%@taglib id=&quot;org.eclipse.jet.controlTags&quot; prefix=&quot;cc&quot;%&gt;
---%&gt;</pre>
+ <pre>
+ &lt;%-- @header
+ This comment will appear as the file header comment
+ in the generated Java code
+ --%&gt;
+ &lt;%--
+ @class
+ This comment will appear as the Java class doc comment
+ in the generated Java code
+ --%&gt;
+ &lt;%-- This comment will not appear in the template output --%&gt;
+ &lt;%-- This directive is not used
+ &lt;%@taglib id=&quot;org.eclipse.jet.controlTags&quot; prefix=&quot;cc&quot;%&gt;
+ --%&gt;</pre>
<h3>Invalid comments</h3>
<p>Comments may not appear within other JET elements. The following
@@ -43,7 +62,9 @@
<p>The following is an example of an escaped JET comments:</p>
- <pre>&lt;\%-- this will show in the template output --%\&gt;</pre>
+ <pre>&lt;\%-- this will show in the template output --%\&gt;
+
+ </pre>
</body>
</html>

Back to the top