google / google/xls

[dslx] comment-to-doc extraction capabilities (a la rustdoc?)

Open
#1,049 0 comments 0 reactions 0 assignees View on GitHub
dslx enhancement
Dominant language
C++
Stars
1.9k
Forks
283
Avg merge
2d 10h
Merged PRs (30d)
135

Description

With the auto-formatter we'll grow a way to associate comments with AST nodes, which we can leverage to automatically spit out javadoc like API / function documentation. We currently do that manually with the DSLX stdlib.

Also opens up the possibility for doctesting.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.