function

Documentation

Index

• func GetDescriptionOfFunction(endingLineIndex int, lines []string) string
• func GetPostProcessedDescriptionOfFunction(endingLineIndex int, lines []string) string
• func ParseFiles(name, pathFunctionFile string, mainFolder Folder)
• func ParseHTML(pageData PageData, pathToSave, pathFunctionFile string)
• func PostProcessingDescription(comment string) string
• type File
• type Folder
  • func FolderMaker(path string) Folder
• type Function
  • func GetAllFunctionsOfLines(lines []string, path string) []Function
• type PageData

Functions

func GetDescriptionOfFunction

func GetDescriptionOfFunction(endingLineIndex int, lines []string) string

func GetPostProcessedDescriptionOfFunction

func GetPostProcessedDescriptionOfFunction(endingLineIndex int, lines []string) string

func ParseFiles

func ParseFiles(name, pathFunctionFile string, mainFolder Folder)

func ParseHTML

func ParseHTML(pageData PageData, pathToSave, pathFunctionFile string)

func PostProcessingDescription

func PostProcessingDescription(comment string) string

Types

type File

type File struct {
	Path string
	HREF string
	Slug string
}

File for the left menu

type Folder

type Folder struct {
	Name       string
	Files      []File
	SubFolders []Folder
	First      bool
}

Folder for the left menu

func FolderMaker

func FolderMaker(path string) Folder

type Function

type Function struct {
	Prototype   string
	Description string
	Path        string
	Line        int
}

Function in C language

func GetAllFunctionsOfLines

func GetAllFunctionsOfLines(lines []string, path string) []Function

type PageData

type PageData struct {
	PageTitle   string
	FolderTitle string
	MainFolder  Folder
	Functions   []Function
}

PageData struct for html info