Module com.sun.codemodel
Package com.sun.codemodel

Class JDocComment

  • All Implemented Interfaces:
    JGenerable, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<java.lang.Object>, java.util.Collection<java.lang.Object>, java.util.List<java.lang.Object>, java.util.RandomAccess
    public class JDocComment
extends JCommentPart
implements JGenerable
    JavaDoc comment.

    A javadoc comment consists of multiple parts. There's the main part (that comes the first in in the comment section), then the parameter parts (@param), the return part (@return), and the throws parts (@throws). TODO: it would be nice if we have JComment class and we can derive this class from there.

    See Also:
    Serialized Form

    • Field Summary

      • Fields inherited from class java.util.AbstractList

        modCount

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      JCommentPart addDeprecated()
      add an @deprecated tag to the javadoc, with the associated message.
      JCommentPart addParam​(JVar param)
      Append a text to an @param tag.
      JCommentPart addParam​(java.lang.String param)
      Append a text to a @param tag to the javadoc
      JCommentPart addReturn()
      Appends a text to @return tag.
      JCommentPart addThrows​(JClass exception)
      add an @throws tag to the javadoc
      JCommentPart addThrows​(java.lang.Class<? extends java.lang.Throwable> exception)
      add an @throws tag to the javadoc
      java.util.Map<java.lang.String,​java.lang.String> addXdoclet​(java.lang.String name)
      add an xdoclet.
      java.util.Map<java.lang.String,​java.lang.String> addXdoclet​(java.lang.String name, java.lang.String attribute, java.lang.String value)
      add an xdoclet.
      java.util.Map<java.lang.String,​java.lang.String> addXdoclet​(java.lang.String name, java.util.Map<java.lang.String,​java.lang.String> attributes)
      add an xdoclet.
      JDocComment append​(java.lang.Object o)
      Appends a new value.
      void generate​(JFormatter f)  

      • Methods inherited from class java.util.ArrayList

        add, addAll, addAll, clear, clone, contains, ensureCapacity, equals, forEach, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

      • Methods inherited from class java.util.AbstractCollection

        containsAll, toString

      • Methods inherited from class java.lang.Object

        finalize, getClass, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface java.util.Collection

        parallelStream, stream, toArray

      • Methods inherited from interface java.util.List

        containsAll

    • Constructor Detail

      • JDocComment

        public JDocComment​(JCodeModel owner)

    • Method Detail

      • append

        public JDocComment append​(java.lang.Object o)
        Description copied from class: JCommentPart
        Appends a new value. If the value is JType it will be printed as a @link tag. Otherwise it will be converted to String via Object.toString().
        Overrides:
        append in class JCommentPart

      • addParam

        public JCommentPart addParam​(java.lang.String param)
        Append a text to a @param tag to the javadoc

      • addParam

        public JCommentPart addParam​(JVar param)
        Append a text to an @param tag.

      • addThrows

        public JCommentPart addThrows​(java.lang.Class<? extends java.lang.Throwable> exception)
        add an @throws tag to the javadoc

      • addThrows

        public JCommentPart addThrows​(JClass exception)
        add an @throws tag to the javadoc

      • addReturn

        public JCommentPart addReturn()
        Appends a text to @return tag.

      • addDeprecated

        public JCommentPart addDeprecated()
        add an @deprecated tag to the javadoc, with the associated message.

      • addXdoclet

        public java.util.Map<java.lang.String,​java.lang.String> addXdoclet​(java.lang.String name)
        add an xdoclet.

      • addXdoclet

        public java.util.Map<java.lang.String,​java.lang.String> addXdoclet​(java.lang.String name,
                                                                         java.util.Map<java.lang.String,​java.lang.String> attributes)
        add an xdoclet.

      • addXdoclet

        public java.util.Map<java.lang.String,​java.lang.String> addXdoclet​(java.lang.String name,
                                                                         java.lang.String attribute,
                                                                         java.lang.String value)
        add an xdoclet.