com.sun.tools.doclets.formats.html.markup.RawHtml Java Examples

The following examples show how to use com.sun.tools.doclets.formats.html.markup.RawHtml. You can vote up the ones you like or vote down the ones you don't like, and go to the original project or source file by following the links above each example. You may check out the related API usage on the sidebar.
Example #1
Source File: SpecificationTaglet.java    From kodkod with MIT License 6 votes vote down vote up
/**
 * {@inheritDoc}
 */
@Override
public Content getTagletOutput(Doc doc, TagletWriter writer) throws IllegalArgumentException {
	Tag[] tags = doc.tags(getName());
	if (tags.length==0 && doc instanceof MethodDoc) { // inherit if necessary and possible
		final DocFinder.Output inheritedDoc = DocFinder.search(new DocFinder.Input((MethodDoc) doc, this));
		tags = inheritedDoc.holderTag == null ? tags : new Tag[] {inheritedDoc.holderTag};
	}
	if (tags.length==0)
		return null;
	final StringBuilder out = writeHeader(new StringBuilder());
	for(Tag tag : tags) { 
		writeTag(out, tag, writer);
	}
	return new RawHtml(out.toString());
}
 
Example #2
Source File: TagletWriterImpl.java    From hottub with GNU General Public License v2.0 6 votes vote down vote up
/**
 * {@inheritDoc}
 */
public Content throwsTagOutput(ThrowsTag throwsTag) {
    ContentBuilder body = new ContentBuilder();
    Content excName = (throwsTag.exceptionType() == null) ?
            new RawHtml(throwsTag.exceptionName()) :
            htmlWriter.getLink(new LinkInfoImpl(configuration, LinkInfoImpl.Kind.MEMBER,
            throwsTag.exceptionType()));
    body.addContent(HtmlTree.CODE(excName));
    Content desc = htmlWriter.commentTagsToContent(throwsTag, null,
        throwsTag.inlineTags(), false);
    if (desc != null && !desc.isEmpty()) {
        body.addContent(" - ");
        body.addContent(desc);
    }
    HtmlTree result = HtmlTree.DD(body);
    return result;
}
 
Example #3
Source File: TagletWriterImpl.java    From openjdk-8-source with GNU General Public License v2.0 6 votes vote down vote up
/**
 * {@inheritDoc}
 */
public Content throwsTagOutput(ThrowsTag throwsTag) {
    ContentBuilder body = new ContentBuilder();
    Content excName = (throwsTag.exceptionType() == null) ?
            new RawHtml(throwsTag.exceptionName()) :
            htmlWriter.getLink(new LinkInfoImpl(configuration, LinkInfoImpl.Kind.MEMBER,
            throwsTag.exceptionType()));
    body.addContent(HtmlTree.CODE(excName));
    Content desc = htmlWriter.commentTagsToContent(throwsTag, null,
        throwsTag.inlineTags(), false);
    if (desc != null && !desc.isEmpty()) {
        body.addContent(" - ");
        body.addContent(desc);
    }
    HtmlTree result = HtmlTree.DD(body);
    return result;
}
 
Example #4
Source File: TagletWriterImpl.java    From openjdk-jdk8u with GNU General Public License v2.0 6 votes vote down vote up
/**
 * {@inheritDoc}
 */
public Content throwsTagOutput(ThrowsTag throwsTag) {
    ContentBuilder body = new ContentBuilder();
    Content excName = (throwsTag.exceptionType() == null) ?
            new RawHtml(throwsTag.exceptionName()) :
            htmlWriter.getLink(new LinkInfoImpl(configuration, LinkInfoImpl.Kind.MEMBER,
            throwsTag.exceptionType()));
    body.addContent(HtmlTree.CODE(excName));
    Content desc = htmlWriter.commentTagsToContent(throwsTag, null,
        throwsTag.inlineTags(), false);
    if (desc != null && !desc.isEmpty()) {
        body.addContent(" - ");
        body.addContent(desc);
    }
    HtmlTree result = HtmlTree.DD(body);
    return result;
}
 
Example #5
Source File: TagletWriterImpl.java    From jdk8u60 with GNU General Public License v2.0 6 votes vote down vote up
/**
 * {@inheritDoc}
 */
public Content throwsTagOutput(ThrowsTag throwsTag) {
    ContentBuilder body = new ContentBuilder();
    Content excName = (throwsTag.exceptionType() == null) ?
            new RawHtml(throwsTag.exceptionName()) :
            htmlWriter.getLink(new LinkInfoImpl(configuration, LinkInfoImpl.Kind.MEMBER,
            throwsTag.exceptionType()));
    body.addContent(HtmlTree.CODE(excName));
    Content desc = htmlWriter.commentTagsToContent(throwsTag, null,
        throwsTag.inlineTags(), false);
    if (desc != null && !desc.isEmpty()) {
        body.addContent(" - ");
        body.addContent(desc);
    }
    HtmlTree result = HtmlTree.DD(body);
    return result;
}
 
Example #6
Source File: TagletWriterImpl.java    From openjdk-jdk8u-backup with GNU General Public License v2.0 6 votes vote down vote up
/**
 * {@inheritDoc}
 */
public Content throwsTagOutput(ThrowsTag throwsTag) {
    ContentBuilder body = new ContentBuilder();
    Content excName = (throwsTag.exceptionType() == null) ?
            new RawHtml(throwsTag.exceptionName()) :
            htmlWriter.getLink(new LinkInfoImpl(configuration, LinkInfoImpl.Kind.MEMBER,
            throwsTag.exceptionType()));
    body.addContent(HtmlTree.CODE(excName));
    Content desc = htmlWriter.commentTagsToContent(throwsTag, null,
        throwsTag.inlineTags(), false);
    if (desc != null && !desc.isEmpty()) {
        body.addContent(" - ");
        body.addContent(desc);
    }
    HtmlTree result = HtmlTree.DD(body);
    return result;
}
 
Example #7
Source File: TagletWriterImpl.java    From openjdk-8 with GNU General Public License v2.0 6 votes vote down vote up
/**
 * {@inheritDoc}
 */
public Content throwsTagOutput(ThrowsTag throwsTag) {
    ContentBuilder body = new ContentBuilder();
    Content excName = (throwsTag.exceptionType() == null) ?
            new RawHtml(throwsTag.exceptionName()) :
            htmlWriter.getLink(new LinkInfoImpl(configuration, LinkInfoImpl.Kind.MEMBER,
            throwsTag.exceptionType()));
    body.addContent(HtmlTree.CODE(excName));
    Content desc = htmlWriter.commentTagsToContent(throwsTag, null,
        throwsTag.inlineTags(), false);
    if (desc != null && !desc.isEmpty()) {
        body.addContent(" - ");
        body.addContent(desc);
    }
    HtmlTree result = HtmlTree.DD(body);
    return result;
}
 
Example #8
Source File: TagletWriterImpl.java    From TencentKona-8 with GNU General Public License v2.0 6 votes vote down vote up
/**
 * {@inheritDoc}
 */
public Content throwsTagOutput(ThrowsTag throwsTag) {
    ContentBuilder body = new ContentBuilder();
    Content excName = (throwsTag.exceptionType() == null) ?
            new RawHtml(throwsTag.exceptionName()) :
            htmlWriter.getLink(new LinkInfoImpl(configuration, LinkInfoImpl.Kind.MEMBER,
            throwsTag.exceptionType()));
    body.addContent(HtmlTree.CODE(excName));
    Content desc = htmlWriter.commentTagsToContent(throwsTag, null,
        throwsTag.inlineTags(), false);
    if (desc != null && !desc.isEmpty()) {
        body.addContent(" - ");
        body.addContent(desc);
    }
    HtmlTree result = HtmlTree.DD(body);
    return result;
}
 
Example #9
Source File: TagletWriterImpl.java    From openjdk-jdk9 with GNU General Public License v2.0 6 votes vote down vote up
/**
 * {@inheritDoc}
 */
public Content throwsTagOutput(ThrowsTag throwsTag) {
    ContentBuilder body = new ContentBuilder();
    Content excName = (throwsTag.exceptionType() == null) ?
            new RawHtml(throwsTag.exceptionName()) :
            htmlWriter.getLink(new LinkInfoImpl(configuration, LinkInfoImpl.Kind.MEMBER,
            throwsTag.exceptionType()));
    body.addContent(HtmlTree.CODE(excName));
    Content desc = htmlWriter.commentTagsToContent(throwsTag, null,
        throwsTag.inlineTags(), false);
    if (desc != null && !desc.isEmpty()) {
        body.addContent(" - ");
        body.addContent(desc);
    }
    HtmlTree result = HtmlTree.DD(body);
    return result;
}
 
Example #10
Source File: LegacyTaglet.java    From openjdk-8 with GNU General Public License v2.0 5 votes vote down vote up
/**
 * {@inheritDoc}
 */
public Content getTagletOutput(Tag tag, TagletWriter writer)
        throws IllegalArgumentException {
    Content output = writer.getOutputInstance();
    output.addContent(new RawHtml(legacyTaglet.toString(tag)));
    return output;
}
 
Example #11
Source File: TagletWriterImpl.java    From openjdk-8 with GNU General Public License v2.0 5 votes vote down vote up
/**
 * {@inheritDoc}
 */
public Content simpleTagOutput(Tag[] simpleTags, String header) {
    ContentBuilder result = new ContentBuilder();
    result.addContent(HtmlTree.DT(HtmlTree.SPAN(HtmlStyle.simpleTagLabel, new RawHtml(header))));
    ContentBuilder body = new ContentBuilder();
    for (int i = 0; i < simpleTags.length; i++) {
        if (i > 0) {
            body.addContent(", ");
        }
        body.addContent(htmlWriter.commentTagsToContent(
                simpleTags[i], null, simpleTags[i].inlineTags(), false));
    }
    result.addContent(HtmlTree.DD(body));
    return result;
}
 
Example #12
Source File: TagletWriterImpl.java    From openjdk-8 with GNU General Public License v2.0 5 votes vote down vote up
/**
 * {@inheritDoc}
 */
public Content propertyTagOutput(Tag tag, String prefix) {
    Content body = new ContentBuilder();
    body.addContent(new RawHtml(prefix));
    body.addContent(" ");
    body.addContent(HtmlTree.CODE(new RawHtml(tag.text())));
    body.addContent(".");
    Content result = HtmlTree.P(body);
    return result;
}
 
Example #13
Source File: TagletWriterImpl.java    From openjdk-8 with GNU General Public License v2.0 5 votes vote down vote up
/**
 * {@inheritDoc}
 */
public Content paramTagOutput(ParamTag paramTag, String paramName) {
    ContentBuilder body = new ContentBuilder();
    body.addContent(HtmlTree.CODE(new RawHtml(paramName)));
    body.addContent(" - ");
    body.addContent(htmlWriter.commentTagsToContent(paramTag, null, paramTag.inlineTags(), false));
    HtmlTree result = HtmlTree.DD(body);
    return result;
}
 
Example #14
Source File: TagletWriterImpl.java    From openjdk-8 with GNU General Public License v2.0 5 votes vote down vote up
/**
 * {@inheritDoc}
 */
public Content deprecatedTagOutput(Doc doc) {
    ContentBuilder result = new ContentBuilder();
    Tag[] deprs = doc.tags("deprecated");
    if (doc instanceof ClassDoc) {
        if (Util.isDeprecated((ProgramElementDoc) doc)) {
            result.addContent(HtmlTree.SPAN(HtmlStyle.deprecatedLabel,
                    new StringContent(configuration.getText("doclet.Deprecated"))));
            result.addContent(RawHtml.nbsp);
            if (deprs.length > 0) {
                Tag[] commentTags = deprs[0].inlineTags();
                if (commentTags.length > 0) {
                    result.addContent(commentTagsToOutput(null, doc,
                        deprs[0].inlineTags(), false)
                    );
                }
            }
        }
    } else {
        MemberDoc member = (MemberDoc) doc;
        if (Util.isDeprecated((ProgramElementDoc) doc)) {
            result.addContent(HtmlTree.SPAN(HtmlStyle.deprecatedLabel,
                    new StringContent(configuration.getText("doclet.Deprecated"))));
            result.addContent(RawHtml.nbsp);
            if (deprs.length > 0) {
                Content body = commentTagsToOutput(null, doc,
                    deprs[0].inlineTags(), false);
                if (!body.isEmpty())
                    result.addContent(HtmlTree.SPAN(HtmlStyle.deprecationComment, body));
            }
        } else {
            if (Util.isDeprecated(member.containingClass())) {
                result.addContent(HtmlTree.SPAN(HtmlStyle.deprecatedLabel,
                        new StringContent(configuration.getText("doclet.Deprecated"))));
                result.addContent(RawHtml.nbsp);
            }
        }
    }
    return result;
}
 
Example #15
Source File: TagletWriterImpl.java    From openjdk-8 with GNU General Public License v2.0 5 votes vote down vote up
/**
 * {@inheritDoc}
 */
public Content simpleTagOutput(Tag simpleTag, String header) {
    ContentBuilder result = new ContentBuilder();
    result.addContent(HtmlTree.DT(HtmlTree.SPAN(HtmlStyle.simpleTagLabel, new RawHtml(header))));
    Content body = htmlWriter.commentTagsToContent(
            simpleTag, null, simpleTag.inlineTags(), false);
    result.addContent(HtmlTree.DD(body));
    return result;
}
 
Example #16
Source File: LegacyTaglet.java    From openjdk-8 with GNU General Public License v2.0 5 votes vote down vote up
/**
 * {@inheritDoc}
 */
public Content getTagletOutput(Doc holder, TagletWriter writer)
        throws IllegalArgumentException {
    Content output = writer.getOutputInstance();
    Tag[] tags = holder.tags(getName());
    if (tags.length > 0) {
        String tagString = legacyTaglet.toString(tags);
        if (tagString != null) {
            output.addContent(new RawHtml(tagString));
        }
    }
    return output;
}
 
Example #17
Source File: TagletWriterImpl.java    From openjdk-jdk9 with GNU General Public License v2.0 5 votes vote down vote up
/**
 * {@inheritDoc}
 */
public Content simpleTagOutput(Tag[] simpleTags, String header) {
    ContentBuilder result = new ContentBuilder();
    result.addContent(HtmlTree.DT(HtmlTree.SPAN(HtmlStyle.simpleTagLabel, new RawHtml(header))));
    ContentBuilder body = new ContentBuilder();
    for (int i = 0; i < simpleTags.length; i++) {
        if (i > 0) {
            body.addContent(", ");
        }
        body.addContent(htmlWriter.commentTagsToContent(
                simpleTags[i], null, simpleTags[i].inlineTags(), false));
    }
    result.addContent(HtmlTree.DD(body));
    return result;
}
 
Example #18
Source File: LegacyTaglet.java    From hottub with GNU General Public License v2.0 5 votes vote down vote up
/**
 * {@inheritDoc}
 */
public Content getTagletOutput(Tag tag, TagletWriter writer)
        throws IllegalArgumentException {
    Content output = writer.getOutputInstance();
    output.addContent(new RawHtml(legacyTaglet.toString(tag)));
    return output;
}
 
Example #19
Source File: LegacyTaglet.java    From openjdk-8-source with GNU General Public License v2.0 5 votes vote down vote up
/**
 * {@inheritDoc}
 */
public Content getTagletOutput(Doc holder, TagletWriter writer)
        throws IllegalArgumentException {
    Content output = writer.getOutputInstance();
    Tag[] tags = holder.tags(getName());
    if (tags.length > 0) {
        String tagString = legacyTaglet.toString(tags);
        if (tagString != null) {
            output.addContent(new RawHtml(tagString));
        }
    }
    return output;
}
 
Example #20
Source File: TagletWriterImpl.java    From hottub with GNU General Public License v2.0 5 votes vote down vote up
/**
 * {@inheritDoc}
 */
public Content valueTagOutput(FieldDoc field, String constantVal,
        boolean includeLink) {
    return includeLink ?
        htmlWriter.getDocLink(LinkInfoImpl.Kind.VALUE_TAG, field,
            constantVal, false) : new RawHtml(constantVal);
}
 
Example #21
Source File: TagletWriterImpl.java    From hottub with GNU General Public License v2.0 5 votes vote down vote up
/**
 * {@inheritDoc}
 */
public Content simpleTagOutput(Tag simpleTag, String header) {
    ContentBuilder result = new ContentBuilder();
    result.addContent(HtmlTree.DT(HtmlTree.SPAN(HtmlStyle.simpleTagLabel, new RawHtml(header))));
    Content body = htmlWriter.commentTagsToContent(
            simpleTag, null, simpleTag.inlineTags(), false);
    result.addContent(HtmlTree.DD(body));
    return result;
}
 
Example #22
Source File: TagletWriterImpl.java    From hottub with GNU General Public License v2.0 5 votes vote down vote up
/**
 * {@inheritDoc}
 */
public Content simpleTagOutput(Tag[] simpleTags, String header) {
    ContentBuilder result = new ContentBuilder();
    result.addContent(HtmlTree.DT(HtmlTree.SPAN(HtmlStyle.simpleTagLabel, new RawHtml(header))));
    ContentBuilder body = new ContentBuilder();
    for (int i = 0; i < simpleTags.length; i++) {
        if (i > 0) {
            body.addContent(", ");
        }
        body.addContent(htmlWriter.commentTagsToContent(
                simpleTags[i], null, simpleTags[i].inlineTags(), false));
    }
    result.addContent(HtmlTree.DD(body));
    return result;
}
 
Example #23
Source File: TagletWriterImpl.java    From hottub with GNU General Public License v2.0 5 votes vote down vote up
/**
 * {@inheritDoc}
 */
public Content propertyTagOutput(Tag tag, String prefix) {
    Content body = new ContentBuilder();
    body.addContent(new RawHtml(prefix));
    body.addContent(" ");
    body.addContent(HtmlTree.CODE(new RawHtml(tag.text())));
    body.addContent(".");
    Content result = HtmlTree.P(body);
    return result;
}
 
Example #24
Source File: TagletWriterImpl.java    From hottub with GNU General Public License v2.0 5 votes vote down vote up
/**
 * {@inheritDoc}
 */
public Content paramTagOutput(ParamTag paramTag, String paramName) {
    ContentBuilder body = new ContentBuilder();
    body.addContent(HtmlTree.CODE(new RawHtml(paramName)));
    body.addContent(" - ");
    body.addContent(htmlWriter.commentTagsToContent(paramTag, null, paramTag.inlineTags(), false));
    HtmlTree result = HtmlTree.DD(body);
    return result;
}
 
Example #25
Source File: TagletWriterImpl.java    From hottub with GNU General Public License v2.0 5 votes vote down vote up
/**
 * {@inheritDoc}
 */
public Content deprecatedTagOutput(Doc doc) {
    ContentBuilder result = new ContentBuilder();
    Tag[] deprs = doc.tags("deprecated");
    if (doc instanceof ClassDoc) {
        if (Util.isDeprecated((ProgramElementDoc) doc)) {
            result.addContent(HtmlTree.SPAN(HtmlStyle.deprecatedLabel,
                    new StringContent(configuration.getText("doclet.Deprecated"))));
            result.addContent(RawHtml.nbsp);
            if (deprs.length > 0) {
                Tag[] commentTags = deprs[0].inlineTags();
                if (commentTags.length > 0) {
                    result.addContent(commentTagsToOutput(null, doc,
                        deprs[0].inlineTags(), false)
                    );
                }
            }
        }
    } else {
        MemberDoc member = (MemberDoc) doc;
        if (Util.isDeprecated((ProgramElementDoc) doc)) {
            result.addContent(HtmlTree.SPAN(HtmlStyle.deprecatedLabel,
                    new StringContent(configuration.getText("doclet.Deprecated"))));
            result.addContent(RawHtml.nbsp);
            if (deprs.length > 0) {
                Content body = commentTagsToOutput(null, doc,
                    deprs[0].inlineTags(), false);
                if (!body.isEmpty())
                    result.addContent(HtmlTree.SPAN(HtmlStyle.deprecationComment, body));
            }
        } else {
            if (Util.isDeprecated(member.containingClass())) {
                result.addContent(HtmlTree.SPAN(HtmlStyle.deprecatedLabel,
                        new StringContent(configuration.getText("doclet.Deprecated"))));
                result.addContent(RawHtml.nbsp);
            }
        }
    }
    return result;
}
 
Example #26
Source File: LegacyTaglet.java    From openjdk-jdk9 with GNU General Public License v2.0 5 votes vote down vote up
/**
 * {@inheritDoc}
 */
public Content getTagletOutput(Doc holder, TagletWriter writer)
        throws IllegalArgumentException {
    Content output = writer.getOutputInstance();
    Tag[] tags = holder.tags(getName());
    if (tags.length > 0) {
        String tagString = legacyTaglet.toString(tags);
        if (tagString != null) {
            output.addContent(new RawHtml(tagString));
        }
    }
    return output;
}
 
Example #27
Source File: LegacyTaglet.java    From openjdk-jdk9 with GNU General Public License v2.0 5 votes vote down vote up
/**
 * {@inheritDoc}
 */
public Content getTagletOutput(Tag tag, TagletWriter writer)
        throws IllegalArgumentException {
    Content output = writer.getOutputInstance();
    output.addContent(new RawHtml(legacyTaglet.toString(tag)));
    return output;
}
 
Example #28
Source File: TagletWriterImpl.java    From openjdk-jdk9 with GNU General Public License v2.0 5 votes vote down vote up
/**
 * {@inheritDoc}
 */
public Content valueTagOutput(FieldDoc field, String constantVal,
        boolean includeLink) {
    return includeLink ?
        htmlWriter.getDocLink(LinkInfoImpl.Kind.VALUE_TAG, field,
            constantVal, false) : new RawHtml(constantVal);
}
 
Example #29
Source File: TagletWriterImpl.java    From openjdk-jdk9 with GNU General Public License v2.0 5 votes vote down vote up
/**
 * {@inheritDoc}
 */
public Content simpleTagOutput(Tag simpleTag, String header) {
    ContentBuilder result = new ContentBuilder();
    result.addContent(HtmlTree.DT(HtmlTree.SPAN(HtmlStyle.simpleTagLabel, new RawHtml(header))));
    Content body = htmlWriter.commentTagsToContent(
            simpleTag, null, simpleTag.inlineTags(), false);
    result.addContent(HtmlTree.DD(body));
    return result;
}
 
Example #30
Source File: TagletWriterImpl.java    From openjdk-jdk9 with GNU General Public License v2.0 5 votes vote down vote up
/**
 * {@inheritDoc}
 */
public Content paramTagOutput(ParamTag paramTag, String paramName) {
    ContentBuilder body = new ContentBuilder();
    body.addContent(HtmlTree.CODE(new RawHtml(paramName)));
    body.addContent(" - ");
    body.addContent(htmlWriter.commentTagsToContent(paramTag, null, paramTag.inlineTags(), false));
    HtmlTree result = HtmlTree.DD(body);
    return result;
}