scaladoc/dotty.tools.scaladoc/ScaladocCommand

ScaladocCommand

object ScaladocCommand extends CliCommand
class Object
trait Matchable
class Any

Type members

Types

Value members

Concrete methods

override
def cmdName: String
Definition Classes
def helpMsg(using settings: ScaladocSettings)(using SettingsState, Context): String
override
def ifErrorsMsg: String
Definition Classes
def isHelpFlag(using settings: ScaladocSettings)(using SettingsState): Boolean
override
def versionMsg: String
Definition Classes

Inherited methods

protected
def availableOptionsMsg(cond: Setting[_] => Boolean)(using settings: ConcreteSettings)(using SettingsState): String

Creates a help message for a subset of options based on cond

Creates a help message for a subset of options based on cond

Inherited from
CliCommand
def checkUsage(summary: ArgsSummary, sourcesRequired: Boolean)(using settings: ConcreteSettings)(using SettingsState, Context): Option[List[String]]

Provide usage feedback on argument summary, assuming that all settings are already applied in context.

Provide usage feedback on argument summary, assuming that all settings are already applied in context.

Returns

Either Some list of files passed as arguments or None if further processing should be interrupted.

Inherited from
CliCommand
protected
def createUsageMsg(label: String, shouldExplain: Boolean, cond: Setting[_] => Boolean)(using settings: ConcreteSettings)(using SettingsState): String
Inherited from
CliCommand
def distill(args: Array[String], sg: SettingGroup)(ss: SettingsState)(using Context): ArgsSummary

Distill arguments into summary detailing settings, errors and files to main

Distill arguments into summary detailing settings, errors and files to main

Inherited from
CliCommand
protected
def isAdvanced(s: Setting[_])(using settings: ConcreteSettings)(using SettingsState): Boolean
Inherited from
CliCommand
protected
def isHelping(s: Setting[_])(using settings: ConcreteSettings)(using SettingsState): Boolean
Inherited from
CliCommand
protected
def isPrivate(s: Setting[_])(using settings: ConcreteSettings)(using SettingsState): Boolean
Inherited from
CliCommand
protected
def isStandard(s: Setting[_])(using settings: ConcreteSettings)(using SettingsState): Boolean
Inherited from
CliCommand
protected
def isVerbose(s: Setting[_])(using settings: ConcreteSettings)(using SettingsState): Boolean
Inherited from
CliCommand
protected
def isWarning(s: Setting[_])(using settings: ConcreteSettings)(using SettingsState): Boolean
Inherited from
CliCommand
protected
def phasesMessage: String
Inherited from
CliCommand
protected
def shortHelp(s: Setting[_])(using settings: ConcreteSettings)(using SettingsState): String
Inherited from
CliCommand
protected
def shortUsage: String
Inherited from
CliCommand
protected
def usageMessage(using settings: ConcreteSettings)(using SettingsState): String

Messages explaining usage and options

Messages explaining usage and options

Inherited from
CliCommand
protected
def vusageMessage(using settings: ConcreteSettings)(using SettingsState): String
Inherited from
CliCommand
protected
def wusageMessage(using settings: ConcreteSettings)(using SettingsState): String
Inherited from
CliCommand
protected
def xusageMessage(using settings: ConcreteSettings)(using SettingsState): String
Inherited from
CliCommand
protected
def yusageMessage(using settings: ConcreteSettings)(using SettingsState): String
Inherited from
CliCommand

Extensions

Inherited extensions

extension [T](setting: Setting[T])
protected
def value(using ss: SettingsState): T
Inherited from
CliCommand