xref: /aosp_15_r20/external/bazel-skylib/gazelle/bzl/README.md (revision bcb5dc7965af6ee42bf2f21341a2ec00233a8c8a)
1*bcb5dc79SHONG Yifan# Gazelle
2*bcb5dc79SHONG Yifan
3*bcb5dc79SHONG YifanGazelle is a `BUILD` file generator for Bazel. This directory contains a
4*bcb5dc79SHONG Yifanlanguage extension for the Gazelle generator that allows it to automatically
5*bcb5dc79SHONG Yifanparse valid `bzl_library` targets for all `.bzl` files in a repo in which it
6*bcb5dc79SHONG Yifanruns. It will additionally include a `deps` entry tracking every `.bzl` that is
7*bcb5dc79SHONG Yifan`load`ed into the primary file.
8*bcb5dc79SHONG Yifan
9*bcb5dc79SHONG YifanThis can be used, for example, to generate
10*bcb5dc79SHONG Yifan[`stardoc`](https://github.com/bazelbuild/stardoc) documentation for your
11*bcb5dc79SHONG Yifan`.bzl` files, both simplify the task of and improve the quality of
12*bcb5dc79SHONG Yifandocumentation.
13*bcb5dc79SHONG Yifan
14