org.scalastyle.scalariform

ScalaDocChecker

Related Docs: object ScalaDocChecker | package scalariform

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
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. val DefaultIgnoreRegex: String

  5. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  6. def charsBetweenTokens(left: Token, right: Token): Int

    Definition Classes
    Checker
  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. var customErrorKey: Option[String]

    Definition Classes
    Checker
  9. var customMessage: Option[String]

    Definition Classes
    Checker
  10. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  11. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  12. val errorKey: String

    Attributes
    protected
    Definition Classes
    ScalaDocChecker → Checker
  13. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. def getBoolean(parameter: String, defaultValue: Boolean): Boolean

    Attributes
    protected
    Definition Classes
    Checker
  15. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  16. def getInt(parameter: String, defaultValue: Int): Int

    Attributes
    protected
    Definition Classes
    Checker
  17. def getString(parameter: String, defaultValue: String): String

    Attributes
    protected
    Definition Classes
    Checker
  18. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  19. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  20. def isNotObject(s: String): Boolean

    Attributes
    protected
    Definition Classes
    Checker
  21. def isObject(s: String): Boolean

    Attributes
    protected
    Definition Classes
    Checker
  22. var level: Level

    Definition Classes
    Checker
  23. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  24. final def notify(): Unit

    Definition Classes
    AnyRef
  25. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  26. var parameters: Map[String, String]

    Definition Classes
    Checker
  27. def setCustomErrorKey(customErrorKey: Option[String]): Unit

    Definition Classes
    Checker
  28. def setCustomMessage(customMessage: Option[String]): Unit

    Definition Classes
    Checker
  29. def setLevel(level: Level): Unit

    Definition Classes
    Checker
  30. def setParameters(parameters: Map[String, String]): Unit

    Definition Classes
    Checker
  31. val skipPrivate: Boolean

  32. val skipProtected: Boolean

  33. val skipQualifiedPrivate: Boolean

  34. val skipQualifiedProtected: Boolean

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

    Definition Classes
    AnyRef
  36. def toString(): String

    Definition Classes
    AnyRef → Any
  37. def toStyleError[T <: FileSpec](file: T, p: ScalastyleError, level: Level, lines: Lines): Message[T]

    Attributes
    protected
    Definition Classes
    Checker
  38. def verify(ast: CombinedAst): List[ScalastyleError]

    Definition Classes
    ScalaDocChecker → Checker
  39. def verify[T <: FileSpec](file: T, level: Level, ast: CombinedAst, lines: Lines): List[Message[T]]

    Definition Classes
    Checker
  40. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  42. 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