godoc

package

v0.1.4 Latest Latest Go to latest Published: Jun 10, 2026 License: GPL-3.0 Imports: 3 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/hatlesswizard/defsource

Links

Open Source Insights

Documentation ¶

Overview ¶

Package godoc parses Go doc comments into structured DocComment values. Go does not use structured tags like PHPDoc/JavaDoc — instead it relies on prose conventions. This parser extracts structure from:

The first paragraph as summary
"Deprecated:" prefix for deprecation notices
Parameter descriptions from prose patterns

Index ¶

type Parser
- func New() *Parser
- func (p *Parser) Parse(raw string) *docparser.DocComment

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Parser ¶

type Parser struct{}

Parser implements docparser.Parser for Go doc comments.

func New ¶

func New() *Parser

New returns a new Go doc comment parser.

func (*Parser) Parse ¶

func (p *Parser) Parse(raw string) *docparser.DocComment

Parse parses a Go doc comment block into a DocComment. The raw input should be the comment text with // or /* */ delimiters already stripped to bare text.

Source Files ¶

View all Source files

godoc.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL