Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ( ErrorInvalidCommand = errors.New("invalid command") ErrorInvalidArgs = errors.New("invalid arguments for command") ErrorInvalidArgsNumber = errors.New("invalid number of arguments for command") ErrorInvalidArgsMissingOpeningParantheses = errors.New("missing opening paranthesis for argument list") ErrorInvalidArgsMissingClosingParantheses = errors.New("missing closing paranthesis for argument list") ErrorInvalidArgsMissingArguments = errors.New("must provide at least one argument") ErrorInvalidArgsMissingSpecFile = errors.New("file path not found") ErrorInvalidArgsRFCNumber = errors.New("RFC number must be a positive integer") ErrorInvalidArgsURL = errors.New("invalid URL format") )
Functions ¶
func FindReferences ¶
func FindReferences(document string) ([]InlineReference, []InlineError)
Types ¶
type InlineCommand ¶
type InlineCommand string
const ( File InlineCommand = "file" RFC InlineCommand = "rfc" URL InlineCommand = "url" Invalid InlineCommand = "invalid" )
type InlineError ¶
func (InlineError) Error ¶
func (e InlineError) Error() string
func (InlineError) Format ¶
func (e InlineError) Format() string
type InlineReference ¶
type InlineReference struct {
// The command used
Command InlineCommand
// Arguments passed to the command
Args []string
// Line number where the reference was found
LineNumber int
}
Source Files
Click to show internal directories.
Click to hide internal directories.