cmd

Documentation

Overview

Copyright © 2021 Sentry

Generate static documentation of Job definitions

Copyright © 2021 Sentry

Copyright © 2021 Sentry

Copyright © 2021 Sentry

Copyright © 2021 Sentry

Index

• Constants
• func Execute()
• type FieldDefinition
• type GeneralDeclaration
• type StructDefinition

Constants

const DocFileName = "docs/TestFormat.md"

const WritingTestsDocFileName = "docs/Writing-tests.md"

Functions

func Execute

func Execute()

Execute adds all child commands to the root command and sets flags appropriately. This is called by main.main(). It only needs to happen once to the rootCmd.

Types

type FieldDefinition

type FieldDefinition struct {
	FieldName     string
	FieldType     string
	Documentation string
}

type GeneralDeclaration

type GeneralDeclaration struct {
	Name          string
	Documentation string
	Source        string
}

type StructDefinition

type StructDefinition struct {
	TypeName      string
	Documentation string
	Fields        []FieldDefinition
}