com.google.api.tools.framework.aspects.documentation.model

Class ElementDocumentationAttribute

java.lang.Object

com.google.api.tools.framework.aspects.documentation.model.ElementDocumentationAttribute

public abstract class ElementDocumentationAttribute
extends java.lang.Object

An attribute attached by this aspect to elements, representing resolved documentation. For the model itself, this attribute represents the overview documentation. For protocol elements, this represents the documentation of the element, merged from proto comments and doc provided via the service config.

Field Summary

Fields

Modifier and Type	Field and Description
static com.google.inject.Key<ElementDocumentationAttribute>	KEY Key used to access this attribute.

Constructor Summary

Constructors

Constructor and Description
ElementDocumentationAttribute()

Method Summary

Modifier and Type	Method and Description
static ElementDocumentationAttribute	create(java.lang.String doc) Create attribute.
static ElementDocumentationAttribute	create(java.lang.String doc, java.lang.String deprecationDesc)
abstract java.lang.String	deprecationDescription() The deprecation documentation of the proto element, if present.
abstract java.lang.String	documentation() The processed documentation of the proto element, with documentation directives resolved.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

KEY

public static final com.google.inject.Key<ElementDocumentationAttribute> KEY

Key used to access this attribute.

Constructor Detail

ElementDocumentationAttribute

public ElementDocumentationAttribute()

Method Detail

documentation

public abstract java.lang.String documentation()

The processed documentation of the proto element, with documentation directives resolved. Note that comment filtering is not applied to this text; use DocumentationUtil.getScopedDescription(com.google.api.tools.framework.model.ProtoElement) for that.

deprecationDescription

public abstract java.lang.String deprecationDescription()

The deprecation documentation of the proto element, if present.

create

public static ElementDocumentationAttribute create(java.lang.String doc)

Create attribute.

create

public static ElementDocumentationAttribute create(java.lang.String doc,
                                                   java.lang.String deprecationDesc)