doccomment

package
v0.0.27 Latest Latest
Warning

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

Go to latest
Published: Oct 5, 2026 License: MIT Imports: 4 Imported by: 0

Documentation

Overview

Package doccomment gives compiler documentation and editor hover one comment model.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func At

func At(file *syntax.File, pos diag.Pos) string

At returns the adjacent whole-line comment group preceding a declaration.

func Fence

func Fence(language, text string) string

Fence handles examples containing backticks without ending the code block.

func HTML

func HTML(text string) string

HTML uses the same prose/example blocks with escaped source text.

func Markdown

func Markdown(text string) string

Markdown preserves prose and fenced examples, without allowing raw HTML.

func Package

func Package(file *syntax.File) string

Package returns leading prose that is not attached to the first declaration.

Types

This section is empty.

Jump to

Keyboard shortcuts

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