From 20a1a31fa85d71f6fc36b7c895aa80646c8f7fb3 Mon Sep 17 00:00:00 2001 From: Tulir Asokan Date: Thu, 22 Mar 2018 23:45:54 +0200 Subject: Add doc.go files --- config/doc.go | 2 ++ interface/doc.go | 2 ++ matrix/doc.go | 2 ++ matrix/room/doc.go | 2 ++ notification/doc.go | 2 ++ ui/debug/doc.go | 2 ++ ui/doc.go | 2 ++ ui/types/doc.go | 2 ++ ui/widget/doc.go | 2 ++ 9 files changed, 18 insertions(+) create mode 100644 config/doc.go create mode 100644 interface/doc.go create mode 100644 matrix/doc.go create mode 100644 matrix/room/doc.go create mode 100644 notification/doc.go create mode 100644 ui/debug/doc.go create mode 100644 ui/doc.go create mode 100644 ui/types/doc.go create mode 100644 ui/widget/doc.go 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 -- cgit v1.2.3