autodoc: std.crypto.core.aes
documentation is hard to reach
#22312
Labels
bug
Observed behavior contradicts documented or intended behavior
Zig Version
0.14.0-dev.2563+af5e73172
Steps to Reproduce and Observed Behavior
First, open the link to
std.crypto.core.aes
:Next, open the link to
std.crypto.core.aes.AesEncryptCtx
:Next, open the link to
impl.AesEncryptCtx
:I thought I would be able to view the documentation for this type function, but in fact, the result returned was "Declaration not found" as shown in the image above.
Search for
AesEncryptCtx
to find documentation for backend type functions:Documentation for
std.crypto.aes.aesni.AesEncryptCtx
:I think it's inconvenient that we can't find this document without searching. I think this issue occurs when using different backends depending on the conditions (CPU architecture, etc.), just like with
std.crypto.core.aes
.Expected Behavior
We can view the documentation by opening the link to
std.crypto.core.aes.AesEncryptCtx
orimpl.AesEncryptCtx
.It might be good to be able to open the documentation in
aes/aesni.zig
whenbuiltin.cpu.arch == .x86_64 and builtin.zig_backend != .stage2_c and has_aesni and has_avx
istrue
in the environment where the documentation was built.zig/lib/std/crypto/aes.zig
Lines 9 to 16 in 497592c
The above is just an example, there may be a better way.
The text was updated successfully, but these errors were encountered: