Skip to content

Commit

Permalink
docs: added basic per-package documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
evilsocket committed Feb 11, 2018
1 parent f4baac6 commit a5f1c36
Show file tree
Hide file tree
Showing 8 changed files with 16 additions and 0 deletions.
2 changes: 2 additions & 0 deletions core/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
// Package core contains basic utility functions.
package core
2 changes: 2 additions & 0 deletions firewall/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
// Package firewall contains the OS specific implementation of the FirewallManager interface.
package firewall
2 changes: 2 additions & 0 deletions log/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
// Package log contains a transparent interface for logging which interacts with the system event queue.
package log
2 changes: 2 additions & 0 deletions modules/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
// Package modules contains session modules.
package modules
2 changes: 2 additions & 0 deletions net/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
// Package net contains network specific code.
package net
2 changes: 2 additions & 0 deletions packets/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
// Package packets contains structure declarations for network packets and the main packets queue.
package packets
2 changes: 2 additions & 0 deletions session/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
// Package session contains code to manage the interactive session, modules, environment, etc.
package session
2 changes: 2 additions & 0 deletions tls/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
// Package tls contains code for TLS certificate generation and signing.
package tls

0 comments on commit a5f1c36

Please sign in to comment.