Examples of com.sun.javadoc.SeeTag

com.sun.javadoc.SeeTag
Represents a user-defined cross-reference to related documentation. The tag can reference a package, class or member, or can hold plain text. (The plain text might be a reference to something not online, such as a printed book, or be a hard-coded HTML link.) The reference can either be inline with the comment, using {@link}, or a separate block comment, using @see. Method name() returns "@link" (no curly braces) or "@see", depending on the tag. Method kind() returns "@see" for both tags. @version 06/10/97 @author Kaiyang Liu (original) @author Robert Field (rewrite) @author Atul M Dambalkar

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

View Full Code Here

                    }
                    if ("@link".equals(inlineTag.name())) {
                        if (LOG.isLoggable(Level.FINE)) {
                            LOG.fine("Have link: " + print(inlineTag));
                        }
                        final SeeTag linkTag = (SeeTag) inlineTag;
                        return getSerializedLinkFromTag(linkTag);
                    } else if (!isEmpty(inlineTag.text())) {
                        return inlineTag.text();
                    }
                }

View Full Code Here

        for (Tag t : tags) {
            String type = t.name();
            if (type.equalsIgnoreCase("text")) {
                buf.append(t.text());
            } else if (type.equalsIgnoreCase("@link")) {
                SeeTag st = (SeeTag) t;
                buf.append('[');
                if (st.label() != null && st.label().length() > 0) {
                    buf.append(st.label()).append('|');
                }
                buf.append(st.referencedClassName());
                if (st.referencedMemberName() != null) {
                    buf.append('#').append(st.referencedMemberName());
                }
                buf.append("]");
            }
            // TODO support other tags like @see, etc.
        }

View Full Code Here

                    }
                    if ( "@link".equals( inlineTag.name() ) ) {
                        if ( LOG.isLoggable( Level.FINE ) ) {
                            LOG.fine( "Have link: " + print( inlineTag ) );
                        }
                        final SeeTag linkTag = (SeeTag) inlineTag;
                        return getSerializedLinkFromTag( linkTag );
                    }
                    else if ( !isEmpty( inlineTag.text() ) ) {
                        return inlineTag.text();
                    }

View Full Code Here

                    }
                    if ( "@link".equals( inlineTag.name() ) ) {
                        if ( LOG.isLoggable( Level.FINE ) ) {
                            LOG.fine( "Have link: " + print( inlineTag ) );
                        }
                        final SeeTag linkTag = (SeeTag) inlineTag;
                        return getSerializedLinkFromTag( linkTag );
                    }
                    else if ( !isEmpty( inlineTag.text() ) ) {
                        return inlineTag.text();
                    }

View Full Code Here

    if ((seeTags != null) && (seeTags.length > 0)) {
      open("dl class='seealso'");
      around("dt", "See Also:");
      open("dd");
      for (int i = 0; i < seeTags.length; i++) {
        SeeTag seeTag = seeTags[i];
        writer.printSummaryComment(javaDoc, new SeeTag[] { seeTag });
        if (i < (seeTags.length - 1)) {
          writer.write(", ");
        }
      }

View Full Code Here

    StringBuilder text = new StringBuilder();
    for (Tag tag : inlineTags) {
      if ("Text".equals(tag.kind())) {
        text.append(tag.text());
      } else if ("@see".equals(tag.kind())) {
        SeeTag see = (SeeTag) tag;
        text.append("{").append(tag.name()).append(" ");
        if (see.referencedMember() != null) {
          text.append(key(see.referencedMember()));
        } else if (see.referencedClass() != null) {
          text.append(key(see.referencedClass()));
        }
        String tagText = tag.text();
        int idx = tagText.indexOf(' ');
        // Pull out "ModelType some other test" -> "some other text"
        if (idx != -1) {

View Full Code Here

0 1

TOP

Related Classes of com.sun.javadoc.SeeTag

ch.raffael.doclets.pegdown.integrations.idea.DocCommentProcessor

com.getperka.flatpack.doclets.DocStringsDoclet

com.lunatech.doclets.jax.writers.DocletWriter

com.postspectacular.doclet.TextileDoclet

com.qspin.qtaste.toolbox.doclet.HTMLFileWriter

com.sun.jersey.wadl.resourcedoc.ResourceDoclet

de.kruis.padoclet.RefCheckDoclet

doc.doclets.PtDoclet

org.apache.tapestry.mojo.ParametersDoclet$Worker

org.apache.tapestry5.javadoc.ParameterDescription

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.