package srvhttp

import "zgo.at/kommentaar/srvhttp"

Package srvhttp contains HTTP handlers for serving Kommentaar documentation.

Index ¶

• func HTML(args Args) http.HandlerFunc
• func JSON(args Args) http.HandlerFunc
• type Args

Functions ¶

func HTML ¶

func HTML(args Args) http.HandlerFunc

HTML outputs as HTML documentation.

func JSON ¶

func JSON(args Args) http.HandlerFunc

JSON outputs as OpenAPI2 JSON.

Set the "indented" query parameter to get formatted JSON.

Types ¶

type Args ¶

type Args struct {
	Packages []string // Packages to scan.
	Config   string   // Kommentaar config file.
	NoScan   bool     // Don't scan the paths, but instead load and output one of the *File.
	JSONFile string
	HTMLFile string
}

Args for the HTTP handlers.

Source Files ¶

srvhttp.go