lnrpc: add top level command doc tags to enable lncli api doc generation

This commit is contained in:
Keagan McClelland
2023-11-14 17:52:33 -08:00
parent ba4438b923
commit dae80f5db7
7 changed files with 17 additions and 9 deletions

View File

@@ -23,6 +23,7 @@ type RouterClient interface {
// PaymentRequest to the final destination. The call returns a stream of
// payment updates.
SendPaymentV2(ctx context.Context, in *SendPaymentRequest, opts ...grpc.CallOption) (Router_SendPaymentV2Client, error)
// lncli: `trackpayment`
// TrackPaymentV2 returns an update stream for the payment identified by the
// payment hash.
TrackPaymentV2(ctx context.Context, in *TrackPaymentRequest, opts ...grpc.CallOption) (Router_TrackPaymentV2Client, error)
@@ -451,6 +452,7 @@ type RouterServer interface {
// PaymentRequest to the final destination. The call returns a stream of
// payment updates.
SendPaymentV2(*SendPaymentRequest, Router_SendPaymentV2Server) error
// lncli: `trackpayment`
// TrackPaymentV2 returns an update stream for the payment identified by the
// payment hash.
TrackPaymentV2(*TrackPaymentRequest, Router_TrackPaymentV2Server) error