protoc-gen-doc
No long description provided.
Installation
dagger install github.com/cloudnative-pg/daggerverse/protoc-gen-doc@d24d288a7219586f5ad2580f749ab4fe4226d51b
Entrypoint
Return Type
ProtocGenDoc !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
image | String | "pseudomuto/protoc-gen-doc:1.5" | ProtocGenDoc image to use. renovate image: datasource=docker depName=pseudomuto/protoc-gen-doc versioning=docker |
Example
dagger -m github.com/cloudnative-pg/daggerverse/protoc-gen-doc@d24d288a7219586f5ad2580f749ab4fe4226d51b call \
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 generate –proto-dir /path/ –doc-opt “markdown,docs.md”
Return Type
Directory !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
protoDir | Directory ! | - | The directory of the proto files. |
docOpt | String | "markdown,docs.md" | The doc_opt flag to pass to protoc-gen-doc. |
Example
dagger -m github.com/cloudnative-pg/daggerverse/protoc-gen-doc@d24d288a7219586f5ad2580f749ab4fe4226d51b 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)
}