From 0d849dbc050a56db4c7bb5d3a44fc40a79a536d7 Mon Sep 17 00:00:00 2001 From: kpacha Date: Fri, 21 May 2021 21:34:56 +0200 Subject: [PATCH] pkg doc fixed Signed-off-by: kpacha --- config/config.go | 3 ++- core/version.go | 2 ++ logging/log.go | 3 ++- plugin/plugin.go | 2 ++ proxy/plugin/modifier.go | 2 ++ proxy/proxy.go | 3 ++- register/register.go | 2 ++ router/chi/router.go | 2 ++ router/gin/router.go | 3 ++- router/gorilla/router.go | 2 ++ router/httptreemux/router.go | 2 ++ router/mux/router.go | 3 ++- router/negroni/router.go | 2 ++ router/router.go | 3 ++- sd/dnssrv/subscriber.go | 3 ++- sd/subscriber.go | 3 ++- test/doc.go | 3 ++- transport/http/client/executor.go | 2 ++ transport/http/server/server.go | 3 +++ 19 files changed, 39 insertions(+), 9 deletions(-) diff --git a/config/config.go b/config/config.go index fb1ddf5bf..da5c88ea1 100644 --- a/config/config.go +++ b/config/config.go @@ -1,4 +1,5 @@ -// Package config defines the config structs and some config parser interfaces and implementations +/* Package config defines the config structs and some config parser interfaces and implementations + */ // SPDX-License-Identifier: Apache-2.0 package config diff --git a/core/version.go b/core/version.go index f0347f324..56222ee45 100644 --- a/core/version.go +++ b/core/version.go @@ -1,3 +1,5 @@ +/* Package core contains come basic constants and variables + */ // SPDX-License-Identifier: Apache-2.0 package core diff --git a/logging/log.go b/logging/log.go index c138d5f8f..99ec47bef 100644 --- a/logging/log.go +++ b/logging/log.go @@ -1,4 +1,5 @@ -//Package logging provides a simple logger interface +/* Package logging provides a simple logger interface + */ // SPDX-License-Identifier: Apache-2.0 package logging diff --git a/plugin/plugin.go b/plugin/plugin.go index 0a83f5366..a086abd73 100644 --- a/plugin/plugin.go +++ b/plugin/plugin.go @@ -1,3 +1,5 @@ +/* Package plugin provides tools for loading and registering plugins + */ // SPDX-License-Identifier: Apache-2.0 package plugin diff --git a/proxy/plugin/modifier.go b/proxy/plugin/modifier.go index 30dc9e97b..d9b3fb5de 100644 --- a/proxy/plugin/modifier.go +++ b/proxy/plugin/modifier.go @@ -1,3 +1,5 @@ +/* Package plugin provides tools for loading and registering proxy plugins + */ // SPDX-License-Identifier: Apache-2.0 package plugin diff --git a/proxy/proxy.go b/proxy/proxy.go index 9301e32fa..41984e309 100644 --- a/proxy/proxy.go +++ b/proxy/proxy.go @@ -1,4 +1,5 @@ -//Package proxy provides proxy and proxy middleware interfaces and implementations. +/* Package proxy provides proxy and proxy middleware interfaces and implementations. + */ // SPDX-License-Identifier: Apache-2.0 package proxy diff --git a/register/register.go b/register/register.go index 9cc575150..e31c18931 100644 --- a/register/register.go +++ b/register/register.go @@ -1,3 +1,5 @@ +/* Package register offers tools for creating and managing registers. + */ // SPDX-License-Identifier: Apache-2.0 package register diff --git a/router/chi/router.go b/router/chi/router.go index 05e7162a3..d25151f7b 100644 --- a/router/chi/router.go +++ b/router/chi/router.go @@ -1,3 +1,5 @@ +/* Package chi provides some basic implementations for building routers based on go-chi/chi + */ // SPDX-License-Identifier: Apache-2.0 package chi diff --git a/router/gin/router.go b/router/gin/router.go index 6a56b22cf..fb8decba5 100644 --- a/router/gin/router.go +++ b/router/gin/router.go @@ -1,4 +1,5 @@ -// Package gin provides some basic implementations for building routers based on gin-gonic/gin +/* Package gin provides some basic implementations for building routers based on gin-gonic/gin + */ // SPDX-License-Identifier: Apache-2.0 package gin diff --git a/router/gorilla/router.go b/router/gorilla/router.go index 595982083..a8e4eccc4 100644 --- a/router/gorilla/router.go +++ b/router/gorilla/router.go @@ -1,3 +1,5 @@ +/* Package gorilla provides some basic implementations for building routers based on gorilla/mux + */ // SPDX-License-Identifier: Apache-2.0 package gorilla diff --git a/router/httptreemux/router.go b/router/httptreemux/router.go index 635a0ecac..2cdbbee85 100644 --- a/router/httptreemux/router.go +++ b/router/httptreemux/router.go @@ -1,3 +1,5 @@ +/* Package httptreemux provides some basic implementations for building routers based on dimfeld/httptreemux + */ // SPDX-License-Identifier: Apache-2.0 package httptreemux diff --git a/router/mux/router.go b/router/mux/router.go index 55a78e954..6cd34e706 100644 --- a/router/mux/router.go +++ b/router/mux/router.go @@ -1,4 +1,5 @@ -// Package mux provides some basic implementations for building routers based on net/http mux +/* Package mux provides some basic implementations for building routers based on net/http mux + */ // SPDX-License-Identifier: Apache-2.0 package mux diff --git a/router/negroni/router.go b/router/negroni/router.go index 91a06787c..cfb496dc5 100644 --- a/router/negroni/router.go +++ b/router/negroni/router.go @@ -1,3 +1,5 @@ +/* Package negroni provides some basic implementations for building routers based on urfave/negroni + */ // SPDX-License-Identifier: Apache-2.0 package negroni diff --git a/router/router.go b/router/router.go index 3636f4d77..eab03f568 100644 --- a/router/router.go +++ b/router/router.go @@ -1,4 +1,5 @@ -// Package router defines some interfaces for router adapters +/* Package router defines some interfaces for router adapters + */ // SPDX-License-Identifier: Apache-2.0 package router diff --git a/sd/dnssrv/subscriber.go b/sd/dnssrv/subscriber.go index 5023bad5c..5ca2d1781 100644 --- a/sd/dnssrv/subscriber.go +++ b/sd/dnssrv/subscriber.go @@ -1,4 +1,5 @@ -// Package dnssrv defines some implementations for a dns based service discovery +/* Package dnssrv defines some implementations for a dns based service discovery + */ // SPDX-License-Identifier: Apache-2.0 package dnssrv diff --git a/sd/subscriber.go b/sd/subscriber.go index 5739359af..7507028ca 100644 --- a/sd/subscriber.go +++ b/sd/subscriber.go @@ -1,4 +1,5 @@ -// Package sd defines some interfaces and implementations for service discovery +/* Package sd defines some interfaces and implementations for service discovery + */ // SPDX-License-Identifier: Apache-2.0 package sd diff --git a/test/doc.go b/test/doc.go index 8a7f87adc..0718181c2 100644 --- a/test/doc.go +++ b/test/doc.go @@ -1,3 +1,4 @@ -// Package test contains the integration tests for the KrakenD framework +/* Package test contains the integration tests for the KrakenD framework + */ // SPDX-License-Identifier: Apache-2.0 package test diff --git a/transport/http/client/executor.go b/transport/http/client/executor.go index e46577aa6..3f064bbc0 100644 --- a/transport/http/client/executor.go +++ b/transport/http/client/executor.go @@ -1,3 +1,5 @@ +/* Package client provides some http helpers to create http clients and executors + */ // SPDX-License-Identifier: Apache-2.0 package client diff --git a/transport/http/server/server.go b/transport/http/server/server.go index 73979cfed..591fcad99 100644 --- a/transport/http/server/server.go +++ b/transport/http/server/server.go @@ -1,3 +1,6 @@ +/* Package server provides tools to create http servers and handlers wrapping the + lura router +*/ // SPDX-License-Identifier: Apache-2.0 package server