Dagger
Search

dagger-doctum

This module has been generated via dagger init and serves as a reference to
basic module structure as you get started with Dagger.

Two functions have been pre-created. You can modify, delete, or add to them,
as needed. They demonstrate usage of arguments and return types using simple
echo and grep commands. The functions can be called from the dagger CLI or
from one of the SDKs.

The first line in this comment block is a short description line and the
rest is a long description with more detail on the module's purpose or usage,
if appropriate. All modules should have a short description.

Installation

dagger install github.com/jasonmccallister/dagger-doctum@218df37f277a635b6138572e10b01647a86ed56a

Entrypoint

Return Type 
DaggerDoctum !
Arguments
NameTypeDefault ValueDescription
srcDirectory !-The source directory containing the PHP files to document.
versionString "5.5.4"No description provided
imageString "php:8.3-cli-alpine"No description provided
configFileString -No description provided
Example
dagger -m github.com/jasonmccallister/dagger-doctum@218df37f277a635b6138572e10b01647a86ed56a call \
 --src DIR_PATH
func (m *myModule) example(src *Directory) *DaggerDoctum  {
	return dag.
			DaggerDoctum(src)
}
@function
def example(src: dagger.Directory, ) -> dag.DaggerDoctum:
	return (
		dag.dagger_doctum(src)
	)
@func()
example(src: Directory, ): DaggerDoctum {
	return dag
		.daggerDoctum(src)
}

Types

DaggerDoctum 🔗

run() 🔗

Run builds the documentation for the given source directory.

Return Type 
Directory !
Example
dagger -m github.com/jasonmccallister/dagger-doctum@218df37f277a635b6138572e10b01647a86ed56a call \
 --src DIR_PATH run
func (m *myModule) example(src *Directory) *Directory  {
	return dag.
			DaggerDoctum(src).
			Run()
}
@function
def example(src: dagger.Directory, ) -> dagger.Directory:
	return (
		dag.dagger_doctum(src)
		.run()
	)
@func()
example(src: Directory, ): Directory {
	return dag
		.daggerDoctum(src)
		.run()
}

serve() 🔗

Serve builds the documentation for the given source directory and serves it.

Return Type 
Service !
Example
dagger -m github.com/jasonmccallister/dagger-doctum@218df37f277a635b6138572e10b01647a86ed56a call \
 --src DIR_PATH serve
func (m *myModule) example(src *Directory) *Service  {
	return dag.
			DaggerDoctum(src).
			Serve()
}
@function
def example(src: dagger.Directory, ) -> dagger.Service:
	return (
		dag.dagger_doctum(src)
		.serve()
	)
@func()
example(src: Directory, ): Service {
	return dag
		.daggerDoctum(src)
		.serve()
}