mdoc
API
Generated with
mdoc/mdoc

mdoc

package mdoc

Members list

Packages

package mdoc.internal
package mdoc.modifiers

Type members

Classlikes

object Main extends MainProcess

Attributes

Supertypes
trait MainProcess
class Object
trait Matchable
class Any
Self type
Main.type
trait MainProcess

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Main.type
object SbtMain.type
final class MainSettings

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object MainSettings

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
object SbtMain extends MainProcess

This main is meant to be called from a running JVM. Rather than exiting with a non-zero code on error, it will throw an exception. This is useful when calling from another JVM and you don't want this JVM to exit and mdoc fails.

This main is meant to be called from a running JVM. Rather than exiting with a non-zero code on error, it will throw an exception. This is useful when calling from another JVM and you don't want this JVM to exit and mdoc fails.

This is the case for the sbt integration. When an exception is raised, sbt will make the task as failed but won't exit. This provides a better user experience.

Attributes

Supertypes
trait MainProcess
class Object
trait Matchable
class Any
Self type
SbtMain.type
Generated with