aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--config/doc.go2
-rw-r--r--interface/doc.go2
-rw-r--r--matrix/doc.go2
-rw-r--r--matrix/room/doc.go2
-rw-r--r--notification/doc.go2
-rw-r--r--ui/debug/doc.go2
-rw-r--r--ui/doc.go2
-rw-r--r--ui/types/doc.go2
-rw-r--r--ui/widget/doc.go2
9 files changed, 18 insertions, 0 deletions
diff --git a/config/doc.go b/config/doc.go
new file mode 100644
index 0000000..e570e0d
--- /dev/null
+++ b/config/doc.go
@@ -0,0 +1,2 @@
+// Package config contains the wrappers for gomuks configurations and sessions.
+package config
diff --git a/interface/doc.go b/interface/doc.go
new file mode 100644
index 0000000..cc09d44
--- /dev/null
+++ b/interface/doc.go
@@ -0,0 +1,2 @@
+// Package ifc contains interfaces to allow circular function calls without circular imports.
+package ifc
diff --git a/matrix/doc.go b/matrix/doc.go
new file mode 100644
index 0000000..2cd54e2
--- /dev/null
+++ b/matrix/doc.go
@@ -0,0 +1,2 @@
+// Package matrix contains wrappers for gomatrix for use by the UI of gomuks.
+package matrix
diff --git a/matrix/room/doc.go b/matrix/room/doc.go
new file mode 100644
index 0000000..2a4ff4b
--- /dev/null
+++ b/matrix/room/doc.go
@@ -0,0 +1,2 @@
+// Package rooms contains a representation for Matrix rooms and utilities to parse state events.
+package rooms
diff --git a/notification/doc.go b/notification/doc.go
new file mode 100644
index 0000000..05295c6
--- /dev/null
+++ b/notification/doc.go
@@ -0,0 +1,2 @@
+// Package notification contains a simple cross-platform desktop notification sending function.
+package notification
diff --git a/ui/debug/doc.go b/ui/debug/doc.go
new file mode 100644
index 0000000..a321689
--- /dev/null
+++ b/ui/debug/doc.go
@@ -0,0 +1,2 @@
+// Package debug contains utilities to display debug messages while running an interactive tview program.
+package debug
diff --git a/ui/doc.go b/ui/doc.go
new file mode 100644
index 0000000..804b334
--- /dev/null
+++ b/ui/doc.go
@@ -0,0 +1,2 @@
+// Package ui contains the main gomuks UI.
+package ui
diff --git a/ui/types/doc.go b/ui/types/doc.go
new file mode 100644
index 0000000..5bc229c
--- /dev/null
+++ b/ui/types/doc.go
@@ -0,0 +1,2 @@
+// Package types contains common type definitions used mostly by the UI, but also other parts of gomuks.
+package types
diff --git a/ui/widget/doc.go b/ui/widget/doc.go
new file mode 100644
index 0000000..03d2060
--- /dev/null
+++ b/ui/widget/doc.go
@@ -0,0 +1,2 @@
+// Package widget contains additional tview widgets.
+package widget