فهرست منبع

Improve clientlib godoc formatting

Adam Pritchard 7 سال پیش
والد
کامیت
6e99b1f822
1فایلهای تغییر یافته به همراه6 افزوده شده و 0 حذف شده
  1. 6 0
      ClientLibrary/clientlib/clientlib.go

+ 6 - 0
ClientLibrary/clientlib/clientlib.go

@@ -92,13 +92,19 @@ var ErrTimeout = errors.New("clientlib: tunnel connection timeout")
 // StartTunnel makes a Psiphon tunnel connection. It returns an error if the connection
 // was not successful. If the returned error is nil, the returned tunnel can be used
 // to find out the proxy ports and subsequently stop the tunnel.
+//
 // ctx may be cancelable, if the caller wants to be able to interrupt the connection
 // attempt, or context.Background().
+//
 // configJSON will be passed to psiphon.LoadConfig to configure the tunnel. Required.
+//
 // embeddedServerEntryList is the encoded embedded server entry list. It is optional.
+//
 // params are config values that typically need to be overridden at runtime.
+//
 // paramsDelta contains changes that will be applied to the ClientParameters.
 // NOTE: Ordinary users of this library should never need this and should pass nil.
+//
 // noticeReceiver, if non-nil, will be called for each notice emitted by tunnel core.
 // NOTE: Ordinary users of this library should never need this and should pass nil.
 func StartTunnel(ctx context.Context,