docs: added basic per-package documentation

This commit is contained in:
evilsocket 2018-02-11 20:38:59 +01:00
parent f4baac69a5
commit a5f1c36e34
8 changed files with 16 additions and 0 deletions

2
core/doc.go Normal file
View file

@ -0,0 +1,2 @@
// Package core contains basic utility functions.
package core

2
firewall/doc.go Normal file
View file

@ -0,0 +1,2 @@
// Package firewall contains the OS specific implementation of the FirewallManager interface.
package firewall

2
log/doc.go Normal file
View file

@ -0,0 +1,2 @@
// Package log contains a transparent interface for logging which interacts with the system event queue.
package log

2
modules/doc.go Normal file
View file

@ -0,0 +1,2 @@
// Package modules contains session modules.
package modules

2
net/doc.go Normal file
View file

@ -0,0 +1,2 @@
// Package net contains network specific code.
package net

2
packets/doc.go Normal file
View file

@ -0,0 +1,2 @@
// Package packets contains structure declarations for network packets and the main packets queue.
package packets

2
session/doc.go Normal file
View file

@ -0,0 +1,2 @@
// Package session contains code to manage the interactive session, modules, environment, etc.
package session

2
tls/doc.go Normal file
View file

@ -0,0 +1,2 @@
// Package tls contains code for TLS certificate generation and signing.
package tls