From a5f1c36e34d4ad728a230b2fde591e71dbc12e2a Mon Sep 17 00:00:00 2001 From: evilsocket Date: Sun, 11 Feb 2018 20:38:59 +0100 Subject: [PATCH] docs: added basic per-package documentation --- core/doc.go | 2 ++ firewall/doc.go | 2 ++ log/doc.go | 2 ++ modules/doc.go | 2 ++ net/doc.go | 2 ++ packets/doc.go | 2 ++ session/doc.go | 2 ++ tls/doc.go | 2 ++ 8 files changed, 16 insertions(+) create mode 100644 core/doc.go create mode 100644 firewall/doc.go create mode 100644 log/doc.go create mode 100644 modules/doc.go create mode 100644 net/doc.go create mode 100644 packets/doc.go create mode 100644 session/doc.go create mode 100644 tls/doc.go diff --git a/core/doc.go b/core/doc.go new file mode 100644 index 00000000..158c8f83 --- /dev/null +++ b/core/doc.go @@ -0,0 +1,2 @@ +// Package core contains basic utility functions. +package core diff --git a/firewall/doc.go b/firewall/doc.go new file mode 100644 index 00000000..b2629092 --- /dev/null +++ b/firewall/doc.go @@ -0,0 +1,2 @@ +// Package firewall contains the OS specific implementation of the FirewallManager interface. +package firewall diff --git a/log/doc.go b/log/doc.go new file mode 100644 index 00000000..7ae3b82d --- /dev/null +++ b/log/doc.go @@ -0,0 +1,2 @@ +// Package log contains a transparent interface for logging which interacts with the system event queue. +package log diff --git a/modules/doc.go b/modules/doc.go new file mode 100644 index 00000000..6588b04d --- /dev/null +++ b/modules/doc.go @@ -0,0 +1,2 @@ +// Package modules contains session modules. +package modules diff --git a/net/doc.go b/net/doc.go new file mode 100644 index 00000000..b5f781f6 --- /dev/null +++ b/net/doc.go @@ -0,0 +1,2 @@ +// Package net contains network specific code. +package net diff --git a/packets/doc.go b/packets/doc.go new file mode 100644 index 00000000..b60c8d1f --- /dev/null +++ b/packets/doc.go @@ -0,0 +1,2 @@ +// Package packets contains structure declarations for network packets and the main packets queue. +package packets diff --git a/session/doc.go b/session/doc.go new file mode 100644 index 00000000..3daa1dbf --- /dev/null +++ b/session/doc.go @@ -0,0 +1,2 @@ +// Package session contains code to manage the interactive session, modules, environment, etc. +package session diff --git a/tls/doc.go b/tls/doc.go new file mode 100644 index 00000000..64e6f19d --- /dev/null +++ b/tls/doc.go @@ -0,0 +1,2 @@ +// Package tls contains code for TLS certificate generation and signing. +package tls