xmldoc

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 xmldoc parses C# XML documentation comments (/// lines or /** ... */ blocks with XML tags) into structured DocComment values. It handles <summary>, <param>, <returns>, <exception>, <see>, <remarks>, and <example> elements.

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 C# XML doc comments.

func New ¶

func New() *Parser

New returns a new C# XML doc parser.

func (*Parser) Parse ¶

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

Parse parses C# XML documentation comment into a DocComment.

Source Files ¶

View all Source files

xmldoc.go

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