Merge pull request #215 from kitsuyui/update-doc-comment

Update doc comment
kitsuyui · Jul 18, 2023 · 361e0b4 · 361e0b4
2 parents 190fd2e + 65e8e02
commit 361e0b4
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 0 deletions.
diff --git a/resolvers/dns_resolver/dns_resolver.go b/resolvers/dns_resolver/dns_resolver.go
@@ -1,3 +1,5 @@
+// DNS Resolver
+// Resolve IP address by DNS query
 package dns_resolver
 
 import (

diff --git a/resolvers/http_resolver/http_resolver.go b/resolvers/http_resolver/http_resolver.go
@@ -1,3 +1,5 @@
+// HTTP resolver
+// Detect IP address by HTTP / HTTPS response
 package http_resolver
 
 import (

diff --git a/resolvers/stun_resolver/stun_resolver.go b/resolvers/stun_resolver/stun_resolver.go
@@ -1,3 +1,6 @@
+// STUN Resolver
+// Resolve IP address by STUN protocol
+// c.f. https://en.wikipedia.org/wiki/STUN
 package stun_resolver
 
 import (