de.upb.hni.vmagic.util
Class Comments

java.lang.Object
  extended by de.upb.hni.vmagic.util.Comments

public class Comments
extends java.lang.Object

Comment utility functions.


Method Summary
static java.util.List<java.lang.String> getComments(VhdlElement element)
          Returns the comments in front of the given vhdl element.
static void setComments(VhdlElement element, java.util.List<java.lang.String> comments)
          Sets the comments in front of a vhdl element.
static void setComments(VhdlElement element, java.lang.String... comments)
          Sets the comments in front of the vhdl element.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getComments

public static java.util.List<java.lang.String> getComments(VhdlElement element)
Returns the comments in front of the given vhdl element.

Parameters:
element - the vhdl element
Returns:
a list of line comments

setComments

public static void setComments(VhdlElement element,
                               java.util.List<java.lang.String> comments)
Sets the comments in front of a vhdl element.

Parameters:
element - the vhdl element
comments - a list of line comments

setComments

public static void setComments(VhdlElement element,
                               java.lang.String... comments)
Sets the comments in front of the vhdl element.

Parameters:
element - the vhdl element
comments - zero or more line comments