Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type CommentProcessor ¶
type CommentProcessor struct {
}
CommentProcessor processes Go-style documentation comments
func NewCommentProcessor ¶
func NewCommentProcessor() *CommentProcessor
NewCommentProcessor creates a new comment processor
type ErrMergeConflict ¶
type ErrMergeConflict struct {
Path string
Runtime interface{}
Doc interface{}
}
ErrMergeConflict represents a conflict between runtime and documentation
func (*ErrMergeConflict) Error ¶
func (e *ErrMergeConflict) Error() string
type ErrValidation ¶
ErrValidation represents a validation error during merge
func (*ErrValidation) Error ¶
func (e *ErrValidation) Error() string
type Option ¶
type Option func(*mergeOptions)
Option is a functional option for merge configuration
func WithDocFile ¶
WithDocFile uses a given docfile instead of the global registry. Useful for testing internals, not much else.
func WithPreserveExisting ¶
WithPreserveExisting configures whether to keep existing documentation in the OpenAPI Document. If true, existing documentation will not be overwritten by the YAML documentation.
func WithStrictValidation ¶
WithStrictValidation enables strict validation during merge. If true, any potential issue (missing docs, type mismatches etc) will result in an error.
type Pipeline ¶
type Pipeline struct {
// contains filtered or unexported fields
}
Pipeline processes documentation through multiple stages
func NewPipeline ¶
NewPipeline creates a new documentation processing pipeline
Source Files