de.upb.hni.vmagic.annotation
Class CommentAnnotation

java.lang.Object
  extended by de.upb.hni.vmagic.annotation.CommentAnnotation

public class CommentAnnotation
extends java.lang.Object

Comment annotation. The comment annotation is used to store VHDL comments in front of a VhdlElement. Each String in the list of comments represents a line comment. The strings must not contain line breaks. The Comments utility class provides an easier interface to set and get comments.

See Also:
Comments

Constructor Summary
CommentAnnotation(java.util.List<java.lang.String> comments)
          Creates a new comment annotation.
CommentAnnotation(java.lang.String... comments)
          Creates a new comment annotation.
 
Method Summary
 java.util.List<java.lang.String> getComments()
          Returns a modifiable list of line comments.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CommentAnnotation

public CommentAnnotation(java.lang.String... comments)
Creates a new comment annotation.

Parameters:
comments - zero or more line comments

CommentAnnotation

public CommentAnnotation(java.util.List<java.lang.String> comments)
Creates a new comment annotation.

Parameters:
comments - a list of line comments
Method Detail

getComments

public java.util.List<java.lang.String> getComments()
Returns a modifiable list of line comments.

Returns:
a list of line comments