From 014af190c64b2fecbf5d69e9a13e45858e830e81 Mon Sep 17 00:00:00 2001
From: Nick White <git@njw.name>
Date: Tue, 14 Apr 2020 11:37:57 +0100
Subject: Improve documentation throughout

---
 cmd/binarize/main.go     | 1 +
 cmd/preproc/main.go      | 1 +
 cmd/preprocmulti/main.go | 2 ++
 cmd/splittable/main.go   | 2 ++
 cmd/wipe/main.go         | 2 ++
 5 files changed, 8 insertions(+)

(limited to 'cmd')

diff --git a/cmd/binarize/main.go b/cmd/binarize/main.go
index a844982..c7cadb2 100644
--- a/cmd/binarize/main.go
+++ b/cmd/binarize/main.go
@@ -2,6 +2,7 @@
 // Use of this source code is governed by the GPLv3
 // license that can be found in the LICENSE file.
 
+// binarize does fast Integral Image sauvola binarisation on an image
 package main
 
 import (
diff --git a/cmd/preproc/main.go b/cmd/preproc/main.go
index 3323635..e967cd2 100644
--- a/cmd/preproc/main.go
+++ b/cmd/preproc/main.go
@@ -2,6 +2,7 @@
 // Use of this source code is governed by the GPLv3
 // license that can be found in the LICENSE file.
 
+// preproc runs binarisation and wipe preprocessing on an image
 package main
 
 // TODO: come up with a way to set a good ksize automatically
diff --git a/cmd/preprocmulti/main.go b/cmd/preprocmulti/main.go
index ca7799f..911c791 100644
--- a/cmd/preprocmulti/main.go
+++ b/cmd/preprocmulti/main.go
@@ -2,6 +2,8 @@
 // Use of this source code is governed by the GPLv3
 // license that can be found in the LICENSE file.
 
+// preprocmulti runs binarisation with a variety of different binarisation
+// levels, preprocessing and saving each version
 package main
 
 // TODO: come up with a way to set a good ksize automatically
diff --git a/cmd/splittable/main.go b/cmd/splittable/main.go
index 9055cf8..ff5082b 100644
--- a/cmd/splittable/main.go
+++ b/cmd/splittable/main.go
@@ -2,6 +2,8 @@
 // Use of this source code is governed by the GPLv3
 // license that can be found in the LICENSE file.
 
+// splittable is an experimental program to split a table into
+// individual cells suitable for OCR
 package main
 
 import (
diff --git a/cmd/wipe/main.go b/cmd/wipe/main.go
index beeced2..30b0061 100644
--- a/cmd/wipe/main.go
+++ b/cmd/wipe/main.go
@@ -2,6 +2,8 @@
 // Use of this source code is governed by the GPLv3
 // license that can be found in the LICENSE file.
 
+// wipe wipes sections of an image which are outside of an automatically
+// determined content area
 package main
 
 import (
-- 
cgit v1.2.1-24-ge1ad