ldoc-beam

Collect documentation from PATH using embedded Docs, its associated immediate-package sidecar, then classic LDoc embedded in the same BEAM.

PATH is a nonempty binary or character-list filename. A later carrier is tried only when an earlier carrier is absent; a present malformed carrier is an error. Sidecar association is checked against the BEAM module and safe immediate ebin/package layout. The function reads files but never loads target code or searches the code path. It returns {ok, ModuleMap} or a tagged error for BEAM/sidecar reads, invalid BEAM or Docs, invalid sidecar association, malformed classic LDoc, or missing documentation.

Collect documentation from PATH with optional caller-declared EDoc conversion context.

PROVENANCE must be {edoc, Source, Includes} with a nonempty path and a proper list of valid include paths. It is validated before artifact collection, even when embedded Docs take precedence. Conversion context is recorded only if a sidecar is selected. The function does not run EDoc or authenticate the source claim. Carrier precedence and absence-only fallback match collect/1. Success returns {ok, ModuleMap}; failures return {error, Reason}, including {error, invalid_edoc_provenance}. Selected carrier, association, and file failures retain their specific tagged reasons. No target module is loaded.

Read the embedded EEP-48 Docs chunk from the supplied trusted BEAM path.

PATH is a nonempty binary or character-list filename. The function reads that file and does not load its module, search the code path, or fall back to another carrier. It returns {ok, ModuleMap} or {error, Reason}; read failures are tagged read_beam, while malformed BEAM, absent Docs, and unsupported Docs data return invalid_beam, missing_docs, or invalid_docs.