cli/scala.cli.commands/Doc

Doc

object Doc extends ScalaCommand[DocOptions]
class ScalaCommand[DocOptions]
class Command[DocOptions]
class CaseApp[DocOptions]
class Object
trait Matchable
class Any
Doc.type

Type members

Inherited classlikes

implicit class EitherBuildExceptionOps[E <: BuildException, T](either: Either[E, T])
Inherited from:
CommandHelpers

Value members

Concrete methods

def generateScaladocDirPath(build: Successful, logger: Logger, extraArgs: Seq[String]): Either[BuildException, Path]
override def group: String
Definition Classes
Command
def run(options: DocOptions, args: RemainingArgs): Unit
override def sharedOptions(options: DocOptions): Option[SharedOptions]
Definition Classes

Inherited methods

protected def commandLength: Int
Inherited from:
ScalaCommand
def complete(args: Seq[String], index: Int): List[CompletionItem]
Inherited from:
CaseApp
override def completer: Completer[DocOptions]
Definition Classes
ScalaCommand -> CaseApp
Inherited from:
ScalaCommand
def ensureNoDuplicates(): Unit
Inherited from:
CaseApp
override def error(message: Error): Nothing
Definition Classes
ScalaCommand -> CaseApp
Inherited from:
ScalaCommand
def exit(code: Int): Nothing
Inherited from:
CaseApp
def expandArgs(args: List[String]): List[String]
Inherited from:
CaseApp
def fullHelpAsked(progName: String): Nothing
Inherited from:
CaseApp
override def hasFullHelp: Boolean
Definition Classes
ScalaCommand -> CaseApp
Inherited from:
ScalaCommand
def hasHelp: Boolean
Inherited from:
CaseApp
def helpAsked(progName: String, maybeOptions: Either[Error, DocOptions]): Nothing
Inherited from:
CaseApp
override def helpFormat: HelpFormat
Definition Classes
ScalaCommand -> CaseApp
Inherited from:
ScalaCommand
def hidden: Boolean
Inherited from:
Command
def ignoreUnrecognized: Boolean
Inherited from:
CaseApp
def inSipScala: Boolean
Inherited from:
ScalaCommand
def main(progName: String, args: Array[String]): Unit
Inherited from:
CaseApp
def main(args: Array[String]): Unit
Inherited from:
CaseApp
def maybePrintGroupHelp(options: DocOptions): Unit
Inherited from:
ScalaCommand
def name: String
Inherited from:
Command
def names: List[List[String]]
Inherited from:
Command
def parser: Parser[DocOptions]
Inherited from:
CaseApp
override def setArgv(argv: Array[String]): Unit
Definition Classes
Inherited from:
ScalaCommand
def stopAtFirstUnrecognized: Boolean
Inherited from:
CaseApp
def usageAsked(progName: String, maybeOptions: Either[Error, DocOptions]): Nothing
Inherited from:
CaseApp

Inherited fields

protected var argvOpt: Option[Array[String]]
Inherited from:
ScalaCommand
lazy override val nameFormatter: Formatter[Name]
Inherited from:
ScalaCommand

Implicits

Inherited implicits

final implicit def EitherBuildExceptionOps[E <: BuildException, T](either: Either[E, T]): EitherBuildExceptionOps[E, T]
Inherited from:
CommandHelpers