Skip to content

docs: add API doc-comments to eDSL, codegen, and dialect headers - #366

Closed
zeroecco wants to merge 1 commit into
mainfrom
docs/backfill-public-api
Closed

zeroecco wants to merge 1 commit into
mainfrom
docs/backfill-public-api

Conversation

@zeroecco

Copy link
Copy Markdown

Summary

  • Add /// Doxygen-style doc-comments to all public classes and key functions in the eDSL layer (Val, Buffer, Register, Module, Comp<T>, CompContext, CompImpl<T>, DigestVal, ReadIopVal, helper factories)
  • Add doc-comments to the codegen layer (RustStreamEmitter, GpuStreamEmitter, CppStreamEmitter, language syntax classes, emitCode, FileContext, CodegenCLOptions)
  • Add doc-comments to the Zll and ZStruct MLIR dialect headers (codegen traits, utility functions, lookupNearestImplicitArg, lookupModuleAttr)
  • Create CLAUDE.md documenting project purpose, Bazel build/test commands, directory layout, and architectural overview of the eDSL → MLIR → codegen pipeline

Test plan

  • Verify the changed headers still compile: bazel build //zirgen/compiler/edsl:edsl //zirgen/compiler/codegen:codegen //zirgen/Dialect/Zll/... //zirgen/Dialect/ZStruct/...
  • Confirm no new warnings from the doc-comment additions
  • Review CLAUDE.md for accuracy against the current codebase

🤖 Generated with Claude Code

…ders

Add /// Doxygen-style doc-comments to all public classes and functions in
the eDSL (Val, Buffer, Register, Module, Comp, CompContext), codegen
(RustStreamEmitter, GpuStreamEmitter, language syntax classes, emitCode),
and core MLIR dialects (Zll, ZStruct). Create CLAUDE.md with build/test
commands, directory layout, and architecture overview.

Nightshift-Task: docs-backfill
Nightshift-Ref: https://github.com/marcus/nightshift
@flaub flaub closed this Oct 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants