template.ast.Comments.tt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jastadd Show documentation

A metacompilation framework for Java using attribute grammars.

There is a newer version: 2.3.6

# Copyright (c) 2013, The JastAdd Team
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
#     * Redistributions of source code must retain the above copyright notice,
#       this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above copyright
#       notice, this list of conditions and the following disclaimer in the
#       documentation and/or other materials provided with the distribution.
#     * Neither the name of the Lund University nor the names of its
#       contributors may be used to endorse or promote products derived from
#       this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.

# Attribute declaration JavaDoc comment
AttrDecl.docComment = [[
  /**$SourceComment
   * @attribute #attributeKind
   * @aspect #getAspectName
   * #declaredat
   */]]

AttrEq.docComment = [[
  /**$SourceComment
   * @attribute #attributeKind
   * @aspect #getAspectName
   * #declaredat
   */]]

# Collection equation comments are placed in the evaluation code.
CollEq.docComment = [[
/*$SourceComment
 * #declaredat
 */]]

ASTDecl.docComment [[
  /**$SourceComment
$if(HasAspectName)
   * @aspect $AspectName
$endif
$if(HasDeclaredAt)
   * $DeclaredAt
$endif
   */]]

TypeDecl.docComment [[
/**$SourceComment
 * @ast #typeDeclKind
$if(HasAspectName)
 * @aspect $AspectName
$endif
$if(HasDeclaredAt)
 * $DeclaredAt
$endif
#extraDocCommentLines
 */]]