Examples of com.sun.javadoc.Tag

com.sun.javadoc.Tag
Represents a simple documentation tag, such as @since, @author, @version. Given a tag (e.g. "@since 1.2"), holds tag name (e.g. "@since") and tag text (e.g. "1.2"). Tags with structure or which require special processing are handled by subclasses such as ParamTag (for @param), SeeTag (for @see and {@link}), and ThrowsTag (for @throws). @author Robert Field @author Atul M Dambalkar @see SeeTag @see ParamTag @see ThrowsTag @see SerialFieldTag @see Doc#tags()


        // Process the comment as an array of tags.  Doc.commentText()
        // should do this, but it does not.
        String documentation = "";


        Tag tag[] = programElementDoc.tags("UserLevelDocumentation");
        StringBuffer textTag = new StringBuffer();
        for (int k = 0; k < tag.length; k++) {
            textTag.append(tag[k].text());
        }

View Full Code Here

    private static String _inlineTagCommentText(
            ProgramElementDoc programElementDoc) {
        // Process the comment as an array of tags.  Doc.commentText()
        // should do this, but it does not.
        StringBuffer documentation = new StringBuffer();
        Tag tag[] = programElementDoc.inlineTags();
        for (int i = 0; i < tag.length; i++) {
            if (tag[i] instanceof SeeTag) {
                SeeTag seeTag = (SeeTag) tag[i];
                documentation.append("<a href=\"");
                // The dot separated class or package name, if any.

View Full Code Here

            return null;


        // This should only be invoked with 0 or 1 tags. I suppose someone could put @tapestrydoc in the comment block
        // more than once.


        Tag tag = tags[0];


        try
        {
            StringWriter writer = new StringWriter(5000);


            ClassDoc classDoc = (ClassDoc) tag.holder();


            if (firstSeen == null)
                firstSeen = classDoc;


            ClassDescription cd = getDescription(classDoc.qualifiedName());

View Full Code Here

    private static void addResponseDoc(MethodDoc methodDoc,
                                       final MethodDocType methodDocType) {


        final ResponseDocType responseDoc = new ResponseDocType();


        final Tag returnTag = getSingleTagOrNull(methodDoc, "return");
        if (returnTag != null) {
            responseDoc.setReturnDoc(returnTag.text());
        }


        final Tag[] responseParamTags = methodDoc.tags("response.param");
        for (Tag responseParamTag : responseParamTags) {
            // LOG.info( "Have responseparam tag: " + print( responseParamTag ) );

View Full Code Here

        return value == null || value.length() == 0 || value.trim().length() == 0 ? true : false;
    }


    private static void addRequestRepresentationDoc(MethodDoc methodDoc,
                                                    final MethodDocType methodDocType) {
        final Tag requestElement = getSingleTagOrNull(methodDoc, "request.representation.qname");
        final Tag requestExample = getSingleTagOrNull(methodDoc, "request.representation.example");
        if (requestElement != null || requestExample != null) {
            final RequestDocType requestDoc = new RequestDocType();
            final RepresentationDocType representationDoc = new RepresentationDocType();


            /* requestElement exists

View Full Code Here

        final StringBuilder sb = new StringBuilder();
        for (final Iterator<Tag> iter = items.iterator(); iter.hasNext(); ) {
            if (delimiter != null) {
                sb.append(delimiter);
            }
            final Tag item = iter.next();
            sb.append(item.name());
            if (delimiter != null) {
                sb.append(delimiter);
            }
            if (iter.hasNext()) {
                sb.append(separator);

View Full Code Here

            return null;


        // This should only be invoked with 0 or 1 tags. I suppose someone could put @tapestrydoc in the comment block
        // more than once.


        Tag tag = tags[0];


        try
        {
            StringWriter writer = new StringWriter(5000);


            ClassDoc classDoc = (ClassDoc) tag.holder();


            if (firstSeen == null)
                firstSeen = classDoc;


            ClassDescription cd = getDescription(classDoc.qualifiedName());

View Full Code Here

   * @param tags
   *            an array of tags
   */
  private void checkTags(Doc doc, Tag[] tags) {
    for (int i = 0; i < tags.length; i++) {
      Tag tag = tags[i];
      if (!tag.name().equalsIgnoreCase("text")) {
        if (tag instanceof SeeTag) {
          SeeTag seeTag = (SeeTag) tag;
          // getErrorReporter().printNotice(doc.position(),"Ref:
          // "+seeTag.name()+" M:'"+seeTag.referencedMemberName()+"'
          // C:'"+seeTag.referencedClassName()+"'
          // P:'"+seeTag.referencedPackage());
          Doc r = seeTag.referencedMember();
          if (r == null)
            r = seeTag.referencedClass();
          if (r == null)
            r = seeTag.referencedPackage();
          checkReference(doc, r,
              RefCheckDoclet.WARNING_SEE_OR_LINK_REFERENCE);
          return;
        }
        checkTags(doc, tag.firstSentenceTags());
        checkTags(doc, tag.inlineTags());
      }
    }
  }

View Full Code Here

      ScriptingEvent scriptingEvent = new ScriptingEvent(methodDoc);
      boolean bSeenEvent = false;


      for (int i = 0; i < tagArray.length; i++)
      {
         Tag tag = tagArray[i];


         if (EVENT_TAG.equals(tag.name().substring(1)))
         {
            if (bSeenEvent)
            {
               // Move on to the next event
               scriptingEvent.addToClass(clazz);

View Full Code Here

    private static void addResponseDoc(final MethodDoc methodDoc,
                                       final MethodDocType methodDocType) {


        final ResponseDocType responseDoc = new ResponseDocType();


        final Tag returnTag = getSingleTagOrNull(methodDoc, "return");
        if (returnTag != null) {
            responseDoc.setReturnDoc(returnTag.text());
        }


        final Tag[] responseParamTags = methodDoc.tags("response.param");
        for (final Tag responseParamTag : responseParamTags) {
            // LOG.info( "Have responseparam tag: " + print( responseParamTag ) );

View Full Code Here

0 1 2 3

TOP

Related Classes of com.sun.javadoc.Tag

com.google.doctool.Booklet

com.lunatech.doclets.jax.jaxrs.model.MethodOutput

com.lunatech.doclets.jax.jaxrs.model.MethodParameter

com.sun.jersey.samples.generatewadl.util.ExampleDocProcessor

com.sun.jersey.wadl.resourcedoc.ResourceDoclet

com.volantis.mcs.build.GenerateUtilities

de.kruis.padoclet.RefCheckDoclet

doc.doclets.PtDoclet

gr.spinellis.umlgraph.doclet.ClassGraph

net.jangaroo.joodoc.DocImpl

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.