Zig 0.17.0-dev (Split by item)

Shortcut keys
?
Show these tips
S
Focus search field
Esc
Clear focus & close tips
U
Jump to source code
↑
Move up in search results
↓
Move down in search results
↵
Go to active search result
This is an example of documentation generated by ZigDoc, an alternative to Zig's built-in Auto Doc feature. See also examples in other modes/formats. The project being documented here (as the example) is the Zig standard library. Private Function

hasDocComment

Private Function
std.zig.Ast.Render.hasDocComment
fn hasDocComment(tree: Ast, start_token: Ast.TokenIndex, end_token: Ast.TokenIndex) bool

Returns true if there exists a doc comment between the start of token start_token and the start of token end_token.

Params

  • tree: Ast
  • start_token: Ast.TokenIndex
  • end_token: Ast.TokenIndex

File

zig/Ast/Render.zig:2995
2995
2996
2997
2998
2999
3000
3001
fn hasDocComment(tree: Ast, start_token: Ast.TokenIndex, end_token: Ast.TokenIndex) bool {
    return std.mem.findScalar(
        Token.Tag,
        tree.tokens.items(.tag)[start_token..end_token],
        .doc_comment,
    ) != null;
}