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
- Alphabetic
- By Inheritance
Inherited
- ScalaDocChecker
- CombinedChecker
- Checker
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- All
Instance Constructors
- new ScalaDocChecker()
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val DefaultIgnoreOverride: Boolean
- val DefaultIgnoreRegex: String
- val DefaultIgnoreTokenTypes: String
- val DefaultIndentStyle: String
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
charsBetweenTokens(left: Token, right: Token): Int
- Definition Classes
- Checker
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
val
customErrorKey: Option[String]
- Definition Classes
- Checker
-
val
customMessage: Option[String]
- Definition Classes
- Checker
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
val
errorKey: String
- Attributes
- protected
- Definition Classes
- ScalaDocChecker → Checker
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
getBoolean(parameter: String, defaultValue: Boolean): Boolean
- Attributes
- protected
- Definition Classes
- Checker
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
getInt(parameter: String, defaultValue: Int): Int
- Attributes
- protected
- Definition Classes
- Checker
-
def
getString(parameter: String, defaultValue: String): String
- Attributes
- protected
- Definition Classes
- Checker
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
isNotObject(s: String): Boolean
- Attributes
- protected
- Definition Classes
- Checker
-
def
isObject(s: String): Boolean
- Attributes
- protected
- Definition Classes
- Checker
-
val
level: Level
- Definition Classes
- Checker
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
val
parameters: Map[String, String]
- Definition Classes
- Checker
-
def
setCustomErrorKey(customErrorKey: Option[String]): Unit
- Definition Classes
- Checker
-
def
setCustomMessage(customMessage: Option[String]): Unit
- Definition Classes
- Checker
-
def
setLevel(level: Level): Unit
- Definition Classes
- Checker
-
def
setParameters(parameters: Map[String, String]): Unit
- Definition Classes
- Checker
- val skipPrivate: Boolean
- val skipProtected: Boolean
- val skipQualifiedPrivate: Boolean
- val skipQualifiedProtected: Boolean
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
def
toStyleError[T <: FileSpec](file: T, p: ScalastyleError, level: Level, lines: Lines): Message[T]
- Attributes
- protected
- Definition Classes
- Checker
-
def
verify(ast: CombinedAst): List[ScalastyleError]
- Definition Classes
- ScalaDocChecker → Checker
-
def
verify[T <: FileSpec](file: T, level: Level, ast: CombinedAst, lines: Lines): List[Message[T]]
- Definition Classes
- Checker
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )