Skip to content

Top-level Doc Comments Are Not Supported #304

@Leguu

Description

@Leguu

In Something.zig:

//! top level comment

/// inner comment
a: i32

In main.zig:

const Something = @import("Something.zig");
pub fn main() void {
  const some = Something { .a = 2 }; // Something has no documentation
  some.a; // Has top level documentation and inner documentation 
}

Oddly enough, the hover info over some.a includes the top level comment and the inner comment. The expected output should be "inner comment" for a and "top level comment" for Something.

Image

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions