Dagger
Search

protoc-gen-doc

No long description provided.

Installation

dagger install github.com/fcanovai/daggerverse/protoc-gen-doc@631410396495afde7dc18043a1bf52816f82db22

Entrypoint

Return Type
ProtocGenDoc !
Arguments
NameTypeDescription
imageString ProtocGenDoc image to use.
Example
func (m *myModule) example() *ProtocGenDoc  {
	return dag.
			ProtocGenDoc()
}
@function
def example() -> dag.ProtocGenDoc:
	return (
		dag.protoc_gen_doc()
	)
@func()
example(): ProtocGenDoc {
	return dag
		.protocGenDoc()
}

Types

ProtocGenDoc 🔗

generate() 🔗

Generate runs protoc-gen-doc on proto files, returning the generated documentation as a directory.

Example usage: dagger call run –proto-dir /path/ –doc-opt “markdown,docs.md”

Return Type
Directory !
Arguments
NameTypeDefault ValueDescription
protoDirDirectory !-The directory of the proto files.
docOptString "markdown,docs.md"The doc_opt flag to pass to protoc-gen-doc.
Example
dagger -m github.com/fcanovai/daggerverse/protoc-gen-doc@631410396495afde7dc18043a1bf52816f82db22 call \
 generate --proto-dir DIR_PATH
func (m *myModule) example(protoDir *Directory) *Directory  {
	return dag.
			ProtocGenDoc().
			Generate(protoDir)
}
@function
def example(proto_dir: dagger.Directory) -> dagger.Directory:
	return (
		dag.protoc_gen_doc()
		.generate(proto_dir)
	)
@func()
example(protoDir: Directory): Directory {
	return dag
		.protocGenDoc()
		.generate(protoDir)
}