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()

        return value == null || value.isEmpty() || value.trim().isEmpty();
    }


    private static void addRequestRepresentationDoc(final 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

  }


  public String getWrappedType() {
    if (!isWrapped())
      return null;
    Tag tag = Utils.getTag(getParameterDoc(), "inputWrapped");
    return tag.text();
  }

View Full Code Here

    // default to @return tag
    return getOutputDoc();
  }


  public String getOutputDoc() {
    Tag returnDoc = Utils.getTag(declaringMethod, "return");
    if (returnDoc != null)
      return returnDoc.text();
    return null;
  }

View Full Code Here

     * @param c the Doc entry to look for @tagvalue
     * @param prevterm the termination string for the previous element
     * @param term the termination character for each tagged value
     */
    private void tagvalue(Options opt, Doc c) {
  Tag tags[] = c.tags("tagvalue");
  if (tags.length == 0)
      return;
  
  for (Tag tag : tags) {
      String t[] = StringUtil.tokenize(tag.text());

View Full Code Here

  }
    }


    /** Return true if c has a @hidden tag associated with it */
    private boolean hidden(ProgramElementDoc c) {
  Tag tags[] = c.tags("hidden");
  if (tags.length > 0)
      return true;
  tags = c.tags("view");
  if (tags.length > 0)
      return true;

View Full Code Here

     * @param c the Doc entry to look for @tagvalue
     * @param prevterm the termination string for the previous element
     * @param term the termination character for each tagged value
     */
    private void tagvalue(Options opt, Doc c) {
  Tag tags[] = c.tags("tagvalue");
  if (tags.length == 0)
      return;
  
  for (Tag tag : tags) {
      String t[] = StringUtil.tokenize(tag.text());

View Full Code Here

  }
    }


    /** Return true if c has a @hidden tag associated with it */
    private boolean hidden(ProgramElementDoc c) {
  Tag tags[] = c.tags("hidden");
  if (tags.length > 0)
      return true;
  tags = c.tags("view");
  if (tags.length > 0)
      return true;

View Full Code Here

        return null;
    }
    
    public void processMethodDoc( MethodDoc methodDoc, MethodDocType methodDocType ) {
        final String tagName = "@example.tag";
        final Tag exampleTag = getTag( methodDoc, tagName );
        if ( exampleTag != null ) {
            final MyNamedValueType namedValueType = new MyNamedValueType();
            namedValueType.setName( EXAMPLE_TAG );
            namedValueType.setValue( exampleTag.text() );
            methodDocType.getAny().add( namedValueType );
        }
    }

View Full Code Here

          if (doc.isOrdinaryClass())
            result.append( "ordinary class; ");  
        }
      else if (field instanceof Tag)
      {
      Tag tag = (Tag) field;
      result.append(tag.name());
      result.append(": ").append(tag.text());
      }
      
      return  result.toString();
    }
  }

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.