format

package

v0.3.0 Latest Latest Go to latest Published: May 9, 2025 License: MIT Imports: 6 Imported by: 0

Details

This section is empty.

This section is empty.

func WriteMarkdown(pkg *doc.Package, out io.Writer) error

WriteMarkdown is a convenience alias that includes all symbols. Deprecated: use WriteMarkdownWithOptions with explicit flags.

func WriteMarkdownWithOptions(pkg *doc.Package, out io.Writer, includePrivate, includeUndocumented bool) error

WriteMarkdownWithOptions generates a markdown representation of a Go package with options for visibility and documentation filters.

Parameters:

Returns:

type StructFieldInfo struct {
	Name       string
	Type       string
	Comment    string
	JSONTag    string
	DynamoTag  string
	DynamoType string
}

StructFieldInfo represents metadata about a struct field, including its name, type, comments, and any struct tags like json or dynamodbav.