yard

package
v0.1.4 Latest Latest
Warning

This package is not in the latest version of its module.

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

Documentation

Overview

Package yard parses Ruby YARD documentation comments into structured DocComment values. It handles @param, @return, @raise, @deprecated, @see, @example, and @option tags.

Index

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 Ruby YARD comments.

func New 

func New() *Parser

New returns a new YARD parser.

func (*Parser) Parse 

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

Parse parses a Ruby YARD comment block into a DocComment.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.