providers.md

providers API

providers.create

load("@cgrindel_bazel_starlib//bazeldoc:defs.bzl", "providers")

providers.create(name, stardoc_input, deps, doc_label, out_basename, doc_basename, header_label,
                 header_basename, symbols, is_stardoc)

Create a documentation provider.

PARAMETERS

Name	Description	Default Value
name	A string which identifies the doc output. If no symbols are provided, all of the symbols which are defined in the corresponding .bzl file are documented.	none
stardoc_input	A string representing the input label provided to the stardoc declaration.	none
deps	A list of deps for the stardoc rule.	none
doc_label	Optional. A string which is the doc label name.	None
out_basename	Optional. A string which is the basename for the output file.	None
doc_basename	Optional. A string which is the basename for the final documentation file.	None
header_label	Optional. A string which is the header label name, if the header is being generated.	None
header_basename	Optional. The basename (string) of the header filename file, if one is being used.	None
symbols	Optional. A list of symbol names that should be included in the documentation.	None
is_stardoc	A bool indicating whether a stardoc declaration should be created.	True

RETURNS

A struct representing a documentation provider.