Skip to content

proposal: x/tools/godoc: add flag to ignore comments beginning with ... #20925

Closed
@jons

Description

@jons

i would like to be able to use godoc and swagger simultaneously on a single API (built with the beego framework) in order to provide two sets of documentation, intended for different audiences.

to achieve this, all that is necessary is to tell godoc to ignore comment lines where the first non-whitespace token begins with "@" (swagger already ignores the untagged, godoc-friendly comments). currently, godoc will instead dump these into its output as though they were natural sentences in a paragraph.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions