mirror of
https://github.com/ziglang/zig.git
synced 2025-02-04 10:36:49 +00:00
c481510c99
previously, in the container view (the type of view that you see when
you look at `std` for example), when listing types and namespaces, we
would only show doc comments places on the direct child decl, which in
the case of the `std` namespace, for example, it's just a bunch of
re-exports.
now, if we don't find a direct doc comment, we chase indirection and
display doc comments placed directly on the definition, if any.
this is the precise priority order:
```
/// 1
pub const Foo = _Foo;
/// 2
const _Foo = struct {
//! 3
};
```
The numbers show the priority order for autodoc.
|
||
|---|---|---|
| .. | ||
| commonmark.js | ||
| index.html | ||
| main.js | ||
| ziglexer.js | ||