From ea2ffbc424d537d2889b9a55f592fd7236411f25 Mon Sep 17 00:00:00 2001 From: Geno Date: Sat, 11 Sep 2021 11:25:54 +0200 Subject: [PATCH] docs: packages --- README.md | 5 +++-- database/docs.go | 4 ++++ mailer/docs.go | 4 ++++ web/api/status/docs.go | 4 ++++ web/auth/docs.go | 4 ++++ web/metrics/docs.go | 4 ++++ web/webtest/docs.go | 4 ++++ 7 files changed, 27 insertions(+), 2 deletions(-) create mode 100644 database/docs.go create mode 100644 mailer/docs.go create mode 100644 web/api/status/docs.go create mode 100644 web/auth/docs.go create mode 100644 web/metrics/docs.go create mode 100644 web/webtest/docs.go diff --git a/README.md b/README.md index 11fd121..e4959c6 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,8 @@ some packages collected for easy and often used functions -- `file`: Read and Save - JSON, TOML - `database`: Start by Config, Migrate -- `worker`: cronjob +- `file`: Read and Save - JSON, TOML +- `mailer`: Send E-Mail and receive for testing - `web`: helpers for golang-gin framework e.g. websocket, metrics, status, auth +- `worker`: cronjob diff --git a/database/docs.go b/database/docs.go new file mode 100644 index 0000000..74afd89 --- /dev/null +++ b/database/docs.go @@ -0,0 +1,4 @@ +/* +Package database implements common functionality for database with gorm. +*/ +package database diff --git a/mailer/docs.go b/mailer/docs.go new file mode 100644 index 0000000..791444c --- /dev/null +++ b/mailer/docs.go @@ -0,0 +1,4 @@ +/* +Package mailer implements common functionality for sending emails and for testing +*/ +package mailer diff --git a/web/api/status/docs.go b/web/api/status/docs.go new file mode 100644 index 0000000..8d4f53a --- /dev/null +++ b/web/api/status/docs.go @@ -0,0 +1,4 @@ +/* +Package status implements for web the module to publish the status with version and other extras +*/ +package status diff --git a/web/auth/docs.go b/web/auth/docs.go new file mode 100644 index 0000000..a885d19 --- /dev/null +++ b/web/auth/docs.go @@ -0,0 +1,4 @@ +/* +Package auth implements for web the module for authentification +*/ +package auth diff --git a/web/metrics/docs.go b/web/metrics/docs.go new file mode 100644 index 0000000..453f325 --- /dev/null +++ b/web/metrics/docs.go @@ -0,0 +1,4 @@ +/* +Package metrics implements for web the module to publish prometheus metrics +*/ +package metrics diff --git a/web/webtest/docs.go b/web/webtest/docs.go new file mode 100644 index 0000000..d4ae5a3 --- /dev/null +++ b/web/webtest/docs.go @@ -0,0 +1,4 @@ +/* +Package webtest implements an easy way to write test for web modules +*/ +package webtest