From 848f961c277525ebba3ab08fadc116970bcfed24 Mon Sep 17 00:00:00 2001
From: Nick White <git@njw.name>
Date: Tue, 14 Apr 2020 11:56:56 +0100
Subject: Add godoc documentation
---
pkg/prob/prob.go | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
(limited to 'pkg/prob')
diff --git a/pkg/prob/prob.go b/pkg/prob/prob.go
index 7a6979a..67baa03 100644
--- a/pkg/prob/prob.go
+++ b/pkg/prob/prob.go
@@ -2,6 +2,7 @@
// Use of this source code is governed by the GPLv3
// license that can be found in the LICENSE file.
+// prob processes .prob files generated by ocropus
package prob
import (
@@ -41,7 +42,7 @@ func getLineAvg(f string) (float64, error) {
return avg, nil
}
-// Note this only processes one line at a time
+// GetLineDetails parses a .prob and corresponding .txt file
func GetLineDetails(probfn string) (line.Details, error) {
var l line.Detail
lines := make(line.Details, 0)
--
cgit v1.2.1-24-ge1ad