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

Class DeprecationDescriptionAttribute

java.lang.Object

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

public abstract class DeprecationDescriptionAttribute
extends java.lang.Object

An attribute attached by this aspect to elements, representing resolved deprecation description documentation. For protocol elements, this represents the deprecation documentation of the element, merged from proto comments and doc provided via the service config. It is only valid to attach deprecation documentation to an element if its `deprecated` option is set to `true`.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
DeprecationDescriptionAttribute()

Method Summary

Modifier and Type	Method and Description
static DeprecationDescriptionAttribute	create(java.lang.String doc) Create attribute.
abstract java.lang.String	deprecationDescription() The content of the deprecation_description this element is associated with.

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<DeprecationDescriptionAttribute> KEY

Key used to access this attribute.

Constructor Detail

DeprecationDescriptionAttribute

public DeprecationDescriptionAttribute()

Method Detail

deprecationDescription

public abstract java.lang.String deprecationDescription()

The content of the deprecation_description this element is associated with.

create

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

Create attribute.