Skip to content

Commit dbf7af7

Browse files
authored
docs(server): give each subpackage a doc.go (#4909)
Signed-off-by: maksim.nabokikh <max.nabokih@gmail.com>
1 parent 7ba767f commit dbf7af7

23 files changed

Lines changed: 43 additions & 24 deletions

File tree

server/connectors/connectors.go

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
// Package connectors holds the server's in-memory cache of opened connectors.
21
package connectors
32

43
import (

server/connectors/doc.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
// Package connectors holds the server's in-memory cache of opened connectors.
2+
package connectors

server/device/device.go

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
1-
// Package device implements the browser-facing side of the OAuth2 device
2-
// authorization grant (RFC 8628): the /device user-code entry page, the
3-
// /device/code authorization request, user-code verification, and the callback
4-
// that completes the flow. The device_code token grant that the device polls for
5-
// lives with the token endpoint.
61
package device
72

83
import (

server/device/doc.go

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
// Package device implements the browser-facing side of the OAuth2 device
2+
// authorization grant (RFC 8628): the /device user-code entry page, the
3+
// /device/code authorization request, user-code verification, and the callback
4+
// that completes the flow. The device_code token grant that the device polls for
5+
// lives with the token endpoint.
6+
package device

server/discovery/discovery.go

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
// Package discovery serves the OIDC discovery document
2-
// (/.well-known/openid-configuration) and the JWKS endpoint (/keys).
31
package discovery
42

53
import (

server/discovery/doc.go

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
// Package discovery serves the OIDC discovery document
2+
// (/.well-known/openid-configuration) and the JWKS endpoint (/keys).
3+
package discovery

server/home/doc.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
// Package home serves the dex landing page at "/".
2+
package home

server/home/home.go

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
// Package home serves the dex landing page at "/".
21
package home
32

43
import (

server/internal/doc.go

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
// Package internal holds the server's wire formats: the protobuf value types and
2+
// the codecs that operate on them — base64 marshaling, the HMAC signer/verifier
3+
// used to protect redirect URLs, and the session-cookie encoder/decoder.
4+
package internal

server/internal/types.pb.go

Lines changed: 0 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)