Class Comment

java.lang.Object
com.sun.tools.corba.ee.idl.Comment

public class Comment extends Object
  • Field Details

  • Constructor Details

    • Comment

      Comment()
    • Comment

      Comment(String text)
  • Method Details

    • text

      public void text(String string)
      Sets comment text
    • text

      public String text()
      Returns comment text
      Returns:
      comment text
    • style

      private int style(String text)
      Returns the comment style of a string.
      Parameters:
      text - text to check the style of
      Returns:
      -1 =Unknown, 0 = Javadoc, 1 = Comment block, 2= Comment Line
    • write

      public void write()
      Writes comment text to standard output (debug).
    • generate

      public void generate(String indent, PrintWriter printStream)
      Writes comment text to the specified print stream in the appropriate format.
      Parameters:
      indent - string to print at the start of each line. null is equivalent to an empty string.
      printStream - stream to write text to
    • print

      private void print(String indent, PrintWriter stream)
      Writes comment to the specified print stream without altering its format. This routine does not alter vertical or horizontal spacing of comment text, thus, it only works well for comments with a non-indented first line.
    • printJavaDoc

      private void printJavaDoc(String indent, PrintWriter stream)
      Writes comment in JavaDoc-style to the specified print stream.
    • printCBlock

      private void printCBlock(String indent, PrintWriter stream)
      Writes comment in c-block-style to the specified print stream.
    • printCppLine

      private void printCppLine(String indent, PrintWriter stream)
      Writes a line comment to the specified print stream.