lnrpc: fix watchtowerrpc doc tags to enable lncli api doc generation

This commit is contained in:
Keagan McClelland
2023-11-14 17:56:37 -08:00
parent dae80f5db7
commit 545b8913c7
3 changed files with 22 additions and 4 deletions

View File

@@ -18,7 +18,7 @@ const _ = grpc.SupportPackageIsVersion7
//
// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
type WatchtowerClient interface {
// lncli: tower info
// lncli: `tower info`
// GetInfo returns general information concerning the companion watchtower
// including its public key and URIs where the server is currently
// listening for clients.
@@ -46,7 +46,7 @@ func (c *watchtowerClient) GetInfo(ctx context.Context, in *GetInfoRequest, opts
// All implementations must embed UnimplementedWatchtowerServer
// for forward compatibility
type WatchtowerServer interface {
// lncli: tower info
// lncli: `tower info`
// GetInfo returns general information concerning the companion watchtower
// including its public key and URIs where the server is currently
// listening for clients.