Module starlark::docs

Types supporting documentation for code written in or for Starlark.

Structs

• Doc
  The main structure that represents the documentation for a given symbol / module.
• DocFunction
  Documents a single function.
• DocModule
  Documents a full module.
• DocObject
  An object with named functions/properties.
• DocProperty
  A single property of an object. These are explicitly not functions (see DocMember).
• DocReturn
  Details about the return value of a function.
• DocString
  The documentation provided by a user for a specific module, object, function, etc.
• DocType
  The type of a given parameter, field, etc.
• Identifier
  The main identifier for a symbol.
• Location
  The file a symbol resides in, and if available its location within that file.
• Pos
  Line / column for where in a file a symbol is.

Enums

• DocItem
• DocMember
  A named member of an object.
• DocParam
  A single parameter of a function.
• DocStringKind
  Controls the formatting to use when parsing DocStrings from raw docstrings
• MarkdownFlavor
  The style of output that is being generated

Traits

• RenderMarkdown
  This object can potentially generate markdown documentation about itself.

Functions

• get_registered_starlark_docs
  Get documentation for all items registered with #[derive(StarlarkDocs)]
• render_docs_as_code
  Render a series of Doc objects into a “starlark” file.

Derive Macros

• StarlarkDocs
  Generate an accessor function on the provided type that returns its documentation based on StarlarkValue::get_methods(). This macro requires that the type implements starlark::StarlarkValue.