summaryrefslogtreecommitdiff
path: root/pkg/bindings/doc.go
diff options
context:
space:
mode:
authorJhon Honce <jhonce@redhat.com>2021-09-13 14:29:22 -0700
committerJhon Honce <jhonce@redhat.com>2021-09-14 07:47:24 -0700
commitd7256be807890892c988cc7d270e3d1bf951397c (patch)
tree53fadc1842f3de6a7c62ab97c8e16f15b0dc4484 /pkg/bindings/doc.go
parentb603c7a4b91d30b33ce987740156f46804f24074 (diff)
downloadpodman-d7256be807890892c988cc7d270e3d1bf951397c.tar.gz
podman-d7256be807890892c988cc7d270e3d1bf951397c.tar.bz2
podman-d7256be807890892c988cc7d270e3d1bf951397c.zip
Enhance bindings for IDE hints
* Follow https://pkg.go.dev/cmd/go#hdr-Generate_Go_files_by_processing_source for leading comment * Add godoc strings for all exposed methods for IDE support * Copy field godoc strings into generated code as function godoc string * Remove unused/unnecessary fields from generator.go structures * Cleanup code regarding template usage Signed-off-by: Jhon Honce <jhonce@redhat.com>
Diffstat (limited to 'pkg/bindings/doc.go')
-rw-r--r--pkg/bindings/doc.go5
1 files changed, 5 insertions, 0 deletions
diff --git a/pkg/bindings/doc.go b/pkg/bindings/doc.go
new file mode 100644
index 000000000..20b4c42e9
--- /dev/null
+++ b/pkg/bindings/doc.go
@@ -0,0 +1,5 @@
+package bindings
+
+/*
+ See https://github.com/containers/podman/blob/main/pkg/bindings/README.md for details.
+*/