orchescala-helper
API
Generated with
orchescala-helper/orchescala.helper/orchescala.helper.dev/orchescala.helper.dev.company/orchescala.helper.dev.company.docs/DocCreator

DocCreator

orchescala.helper.dev.company.docs.DocCreator
trait DocCreator extends DependencyCreator, Helpers

the idea is use Orchescala to create Company's Process documentation.

For a Start you can create a Catalog.

Attributes

Graph
Supertypes
trait Helpers
class Object
trait Matchable
class Any
Known subtypes

Members list

Type members

Inherited classlikes

case class Package(name: String, minorVersion: String)

Attributes

Inherited from:
DependencyCreator
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Package

Attributes

Inherited from:
DependencyCreator
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any

Value members

Abstract methods

protected def publishConfig: Option[PublishConfig]

Concrete methods

protected def apiProjectConfig(projectConfigPath: Path): ApiProjectConfig
protected def configs: Seq[DocProjectConfig]
protected def createCatalog(): Unit
protected def createDynamicConf(): Unit
protected def gitBasePath: Path
def prepareDocs(): Unit
def publishDocs(): Unit

Inherited methods

protected def check(label: String, port: Int): Unit

Attributes

Inherited from:
Helpers
protected def printGraph(dependencyGraph: String): String

Attributes

Inherited from:
DependencyCreator
protected def readReleaseConfig: ReleaseConfig

Attributes

Inherited from:
DependencyCreator
protected def releaseConfig: ReleaseConfig

Attributes

Inherited from:
DependencyCreator

Inherited and Abstract methods

protected def apiConfig: ApiConfig

Attributes

Inherited from:
DependencyCreator

Concrete fields

lazy val projectConfigs: Seq[ProjectConfig]

Inherited fields

lazy val colorMap: Map[String, String]

Attributes

Inherited from:
DependencyCreator
lazy val colors: Seq[(String, String)]

Attributes

Inherited from:
DependencyCreator
lazy protected val printColorLegend: String

Attributes

Inherited from:
DependencyCreator

Givens

Inherited givens

given given_ApiConfig: ApiConfig

Attributes

Inherited from:
DependencyCreator

Extensions

Inherited extensions

extension (proc: proc)
def callOnConsole(path: Path): Unit

Attributes

Inherited from:
Helpers

Implicits

Inherited implicits

implicit lazy protected val workDir: Path

Attributes

Inherited from:
Helpers
Generated with