Class/Object

org.scalastyle.scalariform

ScalaDocChecker

Related Docs: object ScalaDocChecker | package scalariform

Permalink

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
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ScalaDocChecker()

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. val DefaultIgnoreOverride: Boolean

    Permalink

  5. val DefaultIgnoreRegex: String

    Permalink

  6. val DefaultIgnoreTokenTypes: String

    Permalink

  7. val DefaultIndentStyle: String

    Permalink

  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  9. def charsBetweenTokens(left: Token, right: Token): Int

    Permalink
    Definition Classes
    Checker

  10. def clone(): AnyRef

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

  11. var customErrorKey: Option[String]

    Permalink
    Definition Classes
    Checker

  12. var customMessage: Option[String]

    Permalink
    Definition Classes
    Checker

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

    Permalink
    Definition Classes
    AnyRef

  14. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  15. val errorKey: String

    Permalink
    Attributes
    protected
    Definition Classes
    ScalaDocChecker → Checker

  16. def finalize(): Unit

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Checker

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

    Permalink
    Definition Classes
    AnyRef → Any

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

    Permalink
    Attributes
    protected
    Definition Classes
    Checker

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

    Permalink
    Attributes
    protected
    Definition Classes
    Checker

  21. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  22. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  23. def isNotObject(s: String): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Checker

  24. def isObject(s: String): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Checker

  25. var level: Level

    Permalink
    Definition Classes
    Checker

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

    Permalink
    Definition Classes
    AnyRef

  27. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  28. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  29. var parameters: Map[String, String]

    Permalink
    Definition Classes
    Checker

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

    Permalink
    Definition Classes
    Checker

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

    Permalink
    Definition Classes
    Checker

  32. def setLevel(level: Level): Unit

    Permalink
    Definition Classes
    Checker

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

    Permalink
    Definition Classes
    Checker

  34. val skipPrivate: Boolean

    Permalink

  35. val skipProtected: Boolean

    Permalink

  36. val skipQualifiedPrivate: Boolean

    Permalink

  37. val skipQualifiedProtected: Boolean

    Permalink

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

    Permalink
    Definition Classes
    AnyRef

  39. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

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

    Permalink
    Attributes
    protected
    Definition Classes
    Checker

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

    Permalink
    Definition Classes
    ScalaDocChecker → Checker

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

    Permalink
    Definition Classes
    Checker

  43. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from CombinedChecker

Inherited from Checker[CombinedAst]

Inherited from AnyRef

Inherited from Any

Ungrouped