Skip to main content
diff options
authorpelder2009-04-30 09:11:34 -0400
committerpelder2009-04-30 09:11:34 -0400
commitf1d6be6003062dd89896ebe3a938194a7319f243 (patch)
tree944f685fd2ffc5836f0e99e005f7691df524d431 /doc/org.eclipse.jet.doc/references/syntax/jetSyntaxComments.xhtml
parent7714d5bae887506f7941b451c5c6b5da08011cbf (diff)
This commit was manufactured by cvs2svn to create tag 'v200904300915'.v200904300915
Diffstat (limited to 'doc/org.eclipse.jet.doc/references/syntax/jetSyntaxComments.xhtml')
1 files changed, 0 insertions, 71 deletions
diff --git a/doc/org.eclipse.jet.doc/references/syntax/jetSyntaxComments.xhtml b/doc/org.eclipse.jet.doc/references/syntax/jetSyntaxComments.xhtml
deleted file mode 100644
index b66ee88..0000000
--- a/doc/org.eclipse.jet.doc/references/syntax/jetSyntaxComments.xhtml
+++ /dev/null
@@ -1,71 +0,0 @@
-<?xml version='1.0'?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "">
- <head>
- <title>JET Comment Reference Syntax</title>
- <link charset="ISO-8859-1" href="../../book.css" rel="STYLESHEET"
- type="text/css"/>
- </head>
- <body>
- <h2>JET Comment Syntax Reference</h2>
- <p>JET templates may contain comments between the characters
- <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;%-- @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
- are illegal comments:</p>
- <pre>&lt;%@taglib id=&quot;org.eclipse.jet.controlTags&quot; &lt;%-- illegal comment --%&gt;
- prefix=&quot;cc&quot; %&gt;</pre>
- <h3>Escaping comment characters</h3>
- <p>To emit the characters <code>&lt;%--</code> in a templates
- output, enter <code>&lt;\%--</code>. To emit <code>--%&gt;</code>,
- enter <code>--%\&gt;</code>.</p>
- <p>The following is an example of an escaped JET comments:</p>
- <pre>&lt;\%-- this will show in the template output --%\&gt;
- </pre>
- </body>

Back to the top