bash-doxygen
Reference documentation for bash-doxygen
Loading...
Searching...
No Matches
Architecture Decision Records

bash-doxygen Architecture and Reference Documentation

bash-doxygen is a documentation-led Doxygen filter for Bash. It translates intentionally documented Bash declarations into a Doxygen-friendly intermediate representation while keeping source-side intent, generated signatures, diagnostics, release boundaries, and unsupported parser scope explicit.

The repository separates documentation by responsibility:

  • `README.md` provides project orientation, supported behavior, usage, build, release, and testing guidance.
  • `doc/standards/bash/documentation-standard.md` defines the Bash source-documentation standard consumed by this filter.
  • `doc/standards/awk/documentation-standard.md` documents the companion AWK source standard used for the filter implementation.
  • `doc/decisions.md` provides concise summaries of the architecture decisions represented below.
  • ADRs preserve the context, rationale, alternatives, constraints, and consequences behind durable project decisions.
  • Generated Doxygen pages document the maintained AWK filter and shell test harness through the same released-filter integration used by downstream consumers.

The ADRs remain authoritative for architectural intent. Generated navigation and generated Doxygen output are derivative documentation state.

Architecture Decision Records

Documentation Build

This landing page is generated during every stable and canary documentation build. README.intro.md and README.outro.md are maintained source, while the linked ADR list between them is produced by the pinned released adrctl artifact from dependencies-docs.txt.

The composite doc/adr/README.md and Doxygen output under doc/reference/ are ignored derivative state. Dependency acquisition remains explicit through make deps-docs; make adr-index, make docs, and make docs-canary consume already-prepared documentation dependencies and do not repair them.

Routine documentation generation intentionally includes ADR navigation only. It does not add an automatic ADR relationship graph.