Merge pull request luraproject#495 from luraproject/pkg_doc

pkg doc fixed

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
 

core/version.go

@@ -1,3 +1,5 @@
+/* Package core contains come basic constants and variables
+ */
 // SPDX-License-Identifier: Apache-2.0
 package core
 

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
 

plugin/plugin.go

@@ -1,3 +1,5 @@
+/* Package plugin provides tools for loading and registering plugins
+ */
 // SPDX-License-Identifier: Apache-2.0
 package plugin
 

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
 

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
 

register/register.go

@@ -1,3 +1,5 @@
+/* Package register offers tools for creating and managing registers.
+ */
 // SPDX-License-Identifier: Apache-2.0
 package register
 

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
 

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
 

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
 

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
 

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
 

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
 

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
 

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
 

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
 

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

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
 

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