DocumentationTrait (Smithy API 1.51.0)

java.lang.Object
- software.amazon.smithy.model.traits.AbstractTrait
- - software.amazon.smithy.model.traits.StringTrait
  - - software.amazon.smithy.model.traits.DocumentationTrait

All Implemented Interfaces:

FromSourceLocation, ToNode, ToShapeId, Trait
```
public final class DocumentationTrait
extends StringTrait
```
Adds documentation to a model.

- Nested Class Summary
  
  Nested Classes
  Modifier and Type Class Description
  
  static class DocumentationTrait.Provider
- Field Summary
  
  Fields
  Modifier and Type Field Description
  
  static ShapeId ID
- Constructor Summary
  
  Constructors
  Constructor Description
  
  DocumentationTrait(java.lang.String value)
  
  DocumentationTrait(java.lang.String value, SourceLocation sourceLocation)
- Method Summary
  - Methods inherited from class software.amazon.smithy.model.traits.StringTrait
    createNode, getValue
  - Methods inherited from class software.amazon.smithy.model.traits.AbstractTrait
    equals, getSourceLocation, hashCode, setNodeCache, toNode, toShapeId, toString
  - Methods inherited from class java.lang.Object
    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  - Methods inherited from interface software.amazon.smithy.model.traits.Trait
    isSynthetic

Field Detail
- ID
```
public static final ShapeId ID
```

Constructor Detail

DocumentationTrait

public DocumentationTrait(java.lang.String value,
                          SourceLocation sourceLocation)

DocumentationTrait

public DocumentationTrait(java.lang.String value)