Skip to content

Commit

Permalink
Add package documentation to certain files
Browse files Browse the repository at this point in the history
  • Loading branch information
Ryanfsdf committed Jul 22, 2020
1 parent 8a51020 commit 3adc2d2
Show file tree
Hide file tree
Showing 7 changed files with 18 additions and 0 deletions.
4 changes: 4 additions & 0 deletions security/s2a/internal/authinfo/authinfo.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@
*
*/

/*
Package authinfo provides authentication and authorization information from the
S2A session result to the gRPC stack.
*/
package authinfo

import (
Expand Down
1 change: 1 addition & 0 deletions security/s2a/internal/fakehandshaker/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
*
*/

// The fakehandshaker binary provides a fake handshaker service for S2A.
package main

import (
Expand Down
1 change: 1 addition & 0 deletions security/s2a/internal/handshaker/handshaker.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
*
*/

// Package handshaker implements the S2A handshaker service.
package handshaker

import (
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@
*
*/

/*
Package aeadcrypter provides the interface for AEAD Crypter implementations
used by S2A.
*/
package aeadcrypter

// S2AAEADCrypter is the interface for an AEAD cipher used by the S2A record
Expand Down
4 changes: 4 additions & 0 deletions security/s2a/internal/record/internal/halfconn/halfconn.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@
*
*/

/*
Package halfconn implements a half connection for managing one side of a TLS 1.3
connection.
*/
package halfconn

import (
Expand Down
1 change: 1 addition & 0 deletions security/s2a/internal/record/record.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
*
*/

// Package record implements the TLS 1.3 record protocol.
package record

import (
Expand Down
3 changes: 3 additions & 0 deletions security/s2a/s2a.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@
*
*/

/*
Package s2a provides the S2A transport credentials used by gRPC.
*/
package s2a

import (
Expand Down

0 comments on commit 3adc2d2

Please sign in to comment.