docgen

Documentation

Overview

internal/docgen/docgen.go

Index

• func Run(ctx context.Context, cfg Config) (string, error)
• type Config
• type Runner
• type RunnerFunc
  • func (f RunnerFunc) Run(ctx context.Context, prompt string, tools []string) (string, error)

Functions

func Run

func Run(ctx context.Context, cfg Config) (string, error)

Run generates GoDoc-style documentation for the provided file.

Types

type Config

type Config struct {
	File   string // file content (capped at 30KB)
	Path   string // original file path
	Runner Runner
}

Config holds all inputs for a docgen run.

type Runner

type Runner interface {
	Run(ctx context.Context, prompt string, tools []string) (string, error)
}

Runner is the port for LLM calls.

type RunnerFunc

type RunnerFunc func(ctx context.Context, prompt string, tools []string) (string, error)

RunnerFunc is a function adapter for Runner.

func (RunnerFunc) Run

func (f RunnerFunc) Run(ctx context.Context, prompt string, tools []string) (string, error)