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

Class DocumentationPagesAttribute

java.lang.Object

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

public abstract class DocumentationPagesAttribute
extends java.lang.Object

An attribute attached to the model to represent normalized documentation pages specified through the documentation configuration.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
DocumentationPagesAttribute()

Method Summary

Modifier and Type	Method and Description
static DocumentationPagesAttribute	create(java.util.List<com.google.api.Page> toplevelPages) Create this attribute.
abstract java.util.List<com.google.api.Page>	toplevelPages() Returns the top level pages of the docset.

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

Key used to access this attribute.

Constructor Detail

DocumentationPagesAttribute

public DocumentationPagesAttribute()

Method Detail

toplevelPages

public abstract java.util.List<com.google.api.Page> toplevelPages()

Returns the top level pages of the docset. Note that comment filtering is not applied to this text; use DocumentationUtil.getScopedToplevelPages(com.google.api.tools.framework.model.Model) for that.

create

public static DocumentationPagesAttribute create(java.util.List<com.google.api.Page> toplevelPages)

Create this attribute.