final case class DocumentationRule(selector: String = "", description: String = "", deprecationDescription: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[DocumentationRule] with Product with Serializable

A documentation rule provides information about individual API elements.

selector

The selector is a comma-separated list of patterns. Each pattern is a qualified name of the element which may end in "*", indicating a wildcard. Wildcards are only allowed at the end and for a whole component of the qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern "*" is used.

description

Description of the selected API(s).

deprecationDescription

Deprecation description of the selected element(s). It can be provided if an element is marked as deprecated.

Annotations
@SerialVersionUID()
Linear Supertypes
Product, Equals, Updatable[DocumentationRule], GeneratedMessage, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DocumentationRule
  2. Product
  3. Equals
  4. Updatable
  5. GeneratedMessage
  6. Serializable
  7. Serializable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DocumentationRule(selector: String = "", description: String = "", deprecationDescription: String = "", unknownFields: UnknownFieldSet = ...)

    selector

    The selector is a comma-separated list of patterns. Each pattern is a qualified name of the element which may end in "*", indicating a wildcard. Wildcards are only allowed at the end and for a whole component of the qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern "*" is used.

    description

    Description of the selected API(s).

    deprecationDescription

    Deprecation description of the selected element(s). It can be provided if an element is marked as deprecated.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. def companion: DocumentationRule.type
    Definition Classes
    DocumentationRule → GeneratedMessage
  7. val deprecationDescription: String
  8. val description: String
  9. def discardUnknownFields: DocumentationRule
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    DocumentationRule → GeneratedMessage
  14. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    DocumentationRule → GeneratedMessage
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. val selector: String
  20. def serializedSize: Int
    Definition Classes
    DocumentationRule → GeneratedMessage
  21. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  22. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  23. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  24. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  25. def toProtoString: String
    Definition Classes
    DocumentationRule → GeneratedMessage
  26. val unknownFields: UnknownFieldSet
  27. def update(ms: (Lens[DocumentationRule, DocumentationRule]) ⇒ Mutation[DocumentationRule]*): DocumentationRule
    Definition Classes
    Updatable
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  31. def withDeprecationDescription(__v: String): DocumentationRule
  32. def withDescription(__v: String): DocumentationRule
  33. def withSelector(__v: String): DocumentationRule
  34. def withUnknownFields(__v: UnknownFieldSet): DocumentationRule
  35. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  36. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    DocumentationRule → GeneratedMessage
  37. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Inherited from Product

Inherited from Equals

Inherited from Updatable[DocumentationRule]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped