#180 Add documentation

doc.go

@@ -1,19 +1,23 @@
 /*
-Module sz-sdk-go-grpc communicates over a network using gRPC to the Senzing's C-based library.
+Module sz-sdk-go-grpc is used to communicate over a network using gRPC to a Senzing gRPC server.
 
 # Overview
 
 The Senzing sz-sdk-go-grpc packages enable Go programs to call Senzing library functions over a network.
 Under the covers, gRPC is used as the protocol to communicate with a Senzing gRPC server.
 
-More information:
-
-- Senzing gRPC server: https://github.com/senzing-garage/serve-grpc
-- Senzing Go SDK API definitions: https://github.com/senzing-garage/sz-sdk-go
-- Senzing Protobuf definitions: https://github.com/senzing-garage/sz-sdk-proto
-
 # Examples
 
 Examples of use can be seen in the xxxx_test.go files.
+
+# Related information
+
+  - [Senzing gRPC server]
+  - [Senzing Go SDK API definitions]
+  - [Senzing Protobuf definitions]
+
+[Senzing gRPC server]: https://github.com/senzing-garage/serve-grpc
+[Senzing Go SDK API definitions]: https://github.com/senzing-garage/sz-sdk-go
+[Senzing Protobuf definitions]: https://github.com/senzing-garage/sz-sdk-proto
 */
 package main

szconfig/doc.go

@@ -1,6 +1,14 @@
 /*
-Package szconfig is used to modify the in-memory representation of a Senzing configuration.
-The gRPC definitions are at https://github.com/senzing-garage/sz-sdk-proto.
-The Senzing gRPC server is at https://github.com/senzing-garage/serve-grpc.
+Package szconfig is used make SzConfig requests to a Senzing gRPC server.
+
+# Related information
+
+  - [Senzing gRPC server]
+  - [Senzing Go SDK API definitions]
+  - [Senzing Protobuf definitions]
+
+[Senzing gRPC server]: https://github.com/senzing-garage/serve-grpc
+[Senzing Go SDK API definitions]: https://github.com/senzing-garage/sz-sdk-go
+[Senzing Protobuf definitions]: https://github.com/senzing-garage/sz-sdk-proto
 */
 package szconfig

szconfigmanager/doc.go

@@ -1,6 +1,14 @@
 /*
-Package Szconfigmanager is used make SzConfigManager requests to a Senzing gRPC server.
-The gRPC definitions are at https://github.com/senzing-garage/sz-sdk-proto.
-The Senzing gRPC server is at https://github.com/senzing-garage/serve-grpc.
+Package szconfigmanager is used make SzConfigManager requests to a Senzing gRPC server.
+
+# Related information
+
+  - [Senzing gRPC server]
+  - [Senzing Go SDK API definitions]
+  - [Senzing Protobuf definitions]
+
+[Senzing gRPC server]: https://github.com/senzing-garage/serve-grpc
+[Senzing Go SDK API definitions]: https://github.com/senzing-garage/sz-sdk-go
+[Senzing Protobuf definitions]: https://github.com/senzing-garage/sz-sdk-proto
 */
 package szconfigmanager

szdiagnostic/doc.go

@@ -1,6 +1,14 @@
 /*
 Package szdiagnostic is used make SzDiagnostic requests to a Senzing gRPC server.
-The gRPC definitions are at https://github.com/senzing-garage/sz-sdk-proto.
-The Senzing gRPC server is at https://github.com/senzing-garage/serve-grpc.
+
+# Related information
+
+  - [Senzing gRPC server]
+  - [Senzing Go SDK API definitions]
+  - [Senzing Protobuf definitions]
+
+[Senzing gRPC server]: https://github.com/senzing-garage/serve-grpc
+[Senzing Go SDK API definitions]: https://github.com/senzing-garage/sz-sdk-go
+[Senzing Protobuf definitions]: https://github.com/senzing-garage/sz-sdk-proto
 */
 package szdiagnostic

szengine/doc.go

@@ -1,6 +1,14 @@
 /*
 Package szengine is used make SzEngine requests to a Senzing gRPC server.
-The gRPC definitions are at https://github.com/senzing-garage/sz-sdk-proto.
-The Senzing gRPC server is at https://github.com/senzing-garage/serve-grpc.
+
+# Related information
+
+  - [Senzing gRPC server]
+  - [Senzing Go SDK API definitions]
+  - [Senzing Protobuf definitions]
+
+[Senzing gRPC server]: https://github.com/senzing-garage/serve-grpc
+[Senzing Go SDK API definitions]: https://github.com/senzing-garage/sz-sdk-go
+[Senzing Protobuf definitions]: https://github.com/senzing-garage/sz-sdk-proto
 */
 package szengine

szproduct/doc.go

@@ -1,6 +1,14 @@
 /*
 Package szproduct is used make SzProduct requests to a Senzing gRPC server.
-The gRPC definitions are at https://github.com/senzing-garage/sz-sdk-proto.
-The Senzing gRPC server is at https://github.com/senzing-garage/serve-grpc.
+
+# Related information
+
+  - [Senzing gRPC server]
+  - [Senzing Go SDK API definitions]
+  - [Senzing Protobuf definitions]
+
+[Senzing gRPC server]: https://github.com/senzing-garage/serve-grpc
+[Senzing Go SDK API definitions]: https://github.com/senzing-garage/sz-sdk-go
+[Senzing Protobuf definitions]: https://github.com/senzing-garage/sz-sdk-proto
 */
 package szproduct