org.scalastyle.scalariform

ScalaDocChecker

class ScalaDocChecker extends CombinedChecker

Checks that the ScalaDoc exists for all accessible members: - classes, traits, case classes and objects - methods - vals, vars and types

The ScalaDoc's structure must satisfy the parameter of the constructor in case of case classes and classes, or the parameter of the methods. The ScalaDoc must include the type parameters. Finally, the ScalaDoc must include return description for non-Unit returning methods.

Linear Supertypes
CombinedChecker, Checker[CombinedAst], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ScalaDocChecker
  2. CombinedChecker
  3. Checker
  4. AnyRef
  5. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ScalaDocChecker()

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 charsBetweenTokens(left: Token, right: Token): Int

    Definition Classes
    Checker

  6. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  7. var customErrorKey: Option[String]

    Definition Classes
    Checker

  8. var customMessage: Option[String]

    Definition Classes
    Checker

  9. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  10. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  11. val errorKey: String

    Attributes
    protected
    Definition Classes
    ScalaDocChecker → Checker

  12. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  13. def getBoolean(parameter: String, defaultValue: Boolean): Boolean

    Attributes
    protected
    Definition Classes
    Checker

  14. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  15. def getInt(parameter: String, defaultValue: Int): Int

    Attributes
    protected
    Definition Classes
    Checker

  16. def getString(parameter: String, defaultValue: String): String

    Attributes
    protected
    Definition Classes
    Checker

  17. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  18. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  19. def isNotObject(s: String): Boolean

    Attributes
    protected
    Definition Classes
    Checker

  20. def isObject(s: String): Boolean

    Attributes
    protected
    Definition Classes
    Checker

  21. var level: Level

    Definition Classes
    Checker

  22. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  23. final def notify(): Unit

    Definition Classes
    AnyRef

  24. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  25. var parameters: Map[String, String]

    Definition Classes
    Checker

  26. def setCustomErrorKey(customErrorKey: Option[String]): Unit

    Attributes
    protected
    Definition Classes
    Checker

  27. def setCustomMessage(customMessage: Option[String]): Unit

    Attributes
    protected
    Definition Classes
    Checker

  28. def setLevel(level: Level): Unit

    Attributes
    protected
    Definition Classes
    Checker

  29. def setParameters(parameters: Map[String, String]): Unit

    Attributes
    protected
    Definition Classes
    Checker

  30. val skipPrivate: Boolean

  31. val skipProtected: Boolean

  32. val skipQualifiedPrivate: Boolean

  33. val skipQualifiedProtected: Boolean

  34. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  35. def toString(): String

    Definition Classes
    AnyRef → Any

  36. def toStyleError[T <: FileSpec](file: T, p: ScalastyleError, level: Level, lines: Lines): Message[T]

    Attributes
    protected
    Definition Classes
    Checker

  37. def verify(ast: CombinedAst): List[ScalastyleError]

    Definition Classes
    ScalaDocChecker → Checker

  38. def verify[T <: FileSpec](file: T, level: Level, ast: CombinedAst, lines: Lines): List[Message[T]]

    Definition Classes
    Checker

  39. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  40. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  41. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from CombinedChecker

Inherited from Checker[CombinedAst]

Inherited from AnyRef

Inherited from Any

Ungrouped