Documentation
¶
Overview ¶
Package scanner provides document scanning functionality.
This package supports scanning and segmenting Markdown documents and Go documentation comments for analysis.
Index ¶
- func FilterRelevantSegments(segments []types.DocSegment, symbols []types.ChangedSymbol) []types.DocSegment
- func ScanGoDoc(filePath string) ([]types.DocSegment, error)
- func ScanGoDocDir(dir string) ([]types.DocSegment, error)
- func ScanMarkdown(filePath string) ([]types.DocSegment, error)
- func ScanMarkdownDir(rootDir string, patterns []string) ([]types.DocSegment, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func FilterRelevantSegments ¶
func FilterRelevantSegments(segments []types.DocSegment, symbols []types.ChangedSymbol) []types.DocSegment
FilterRelevantSegments filters segments that may be relevant to the symbols. This is a pre-filter based on keyword matching.
func ScanGoDoc ¶
func ScanGoDoc(filePath string) ([]types.DocSegment, error)
ScanGoDoc scans a Go file and extracts documentation comments.
func ScanGoDocDir ¶
func ScanGoDocDir(dir string) ([]types.DocSegment, error)
ScanGoDocDir scans a directory for Go documentation comments.
func ScanMarkdown ¶
func ScanMarkdown(filePath string) ([]types.DocSegment, error)
ScanMarkdown scans a Markdown file and returns document segments. Each segment corresponds to a heading and its content.
func ScanMarkdownDir ¶
func ScanMarkdownDir(rootDir string, patterns []string) ([]types.DocSegment, error)
ScanMarkdownDir scans a directory for Markdown files matching the patterns.
Types ¶
This section is empty.
Source Files
Click to show internal directories.
Click to hide internal directories.