Add package comments

.gitlab-ci.yml

@@ -16,5 +16,5 @@ linters:
   stage: quality-assurance
   script:
     - go get -u golang.org/x/lint/golint
-    - golint -min_confidence 0.3 -set_exit_status ./...
+    - golint -min_confidence 0.2 -set_exit_status ./...
   allow_failure: true

auth/auth.go

@@ -1,3 +1,4 @@
+// Package auth manages backends to auth incoming streams
 package auth
 
 import (

auth/basic/basic.go

@@ -1,3 +1,4 @@
+// Package basic provides a basic authentification backend
 package basic
 
 import (

auth/ldap/ldap.go

@@ -1,3 +1,4 @@
+// Package ldap provides a LDAP authentification backend
 package ldap
 
 import (

internal/monitoring/monitoring.go

@@ -1,3 +1,4 @@
+// Package monitoring serves Prometheus monitoring endpoints
 package monitoring
 
 import (

main.go

@@ -1,5 +1,7 @@
 //go:generate pkger
 
+// Package main provides the full-featured server with configuration loading
+// and communication between routines.
 package main
 
 import (

stream/forwarding/forwarding.go

@@ -1,3 +1,4 @@
+// Package forwarding forwards incoming stream to other streaming services
 package forwarding
 
 import (

stream/srt/handler.go

@@ -1,3 +1,4 @@
+// Package srt serves a SRT server
 package srt
 
 import (

stream/srt/srt.go

@@ -1,3 +1,4 @@
+// Package srt serves a SRT server
 package srt
 
 // #include <srt/srt.h>

stream/webrtc/ingest.go

@@ -1,14 +1,15 @@
+// Package webrtc provides the backend to simulate a WebRTC client to send stream
 package webrtc
 
 import (
 	"bufio"
-	"github.com/pion/webrtc/v3"
 	"io"
 	"log"
 	"net"
 	"os/exec"
 
 	"github.com/pion/rtp"
+	"github.com/pion/webrtc/v3"
 	"gitlab.crans.org/nounous/ghostream/stream/srt"
 )
 

stream/webrtc/webrtc.go

@@ -1,3 +1,4 @@
+// Package webrtc provides the backend to simulate a WebRTC client to send stream
 package webrtc
 
 import (

web/handler.go

@@ -1,9 +1,9 @@
+// Package web serves the JavaScript player and WebRTC negociation
 package web
 
 import (
 	"bytes"
 	"encoding/json"
-	"gitlab.crans.org/nounous/ghostream/stream/srt"
 	"html/template"
 	"log"
 	"net"
@@ -12,6 +12,7 @@ import (
 
 	"github.com/markbates/pkger"
 	"gitlab.crans.org/nounous/ghostream/internal/monitoring"
+	"gitlab.crans.org/nounous/ghostream/stream/srt"
 	"gitlab.crans.org/nounous/ghostream/stream/webrtc"
 )
 

web/web.go

@@ -1,3 +1,4 @@
+// Package web serves the JavaScript player and WebRTC negociation
 package web
 
 import (