all: fix documentations

Signed-off-by: Koichi Shiraishi <zchee.io@gmail.com>

Author: zchee

basic.go

@@ -97,14 +97,6 @@ type LocationLink struct {
 	TargetSelectionRange Range `json:"targetSelectionRange"`
 }
 
-// CodeDescription is the structure to capture a description for an error code.
-//
-// @since 3.16.0.
-type CodeDescription struct {
-	// Href an URI to open with more information about the diagnostic error.
-	Href URI `json:"href"`
-}
-
 // Command represents a reference to a command. Provides a title which will be used to represent a command in the UI.
 //
 // Commands are identified by a string identifier.
@@ -649,17 +641,17 @@ type DocumentFilter struct {
 	//
 	// Glob patterns can have the following syntax:
 	//  "*"
-	// to match one or more characters in a path segment
+	// "*" to match one or more characters in a path segment
 	//  "?"
-	// to match on one character in a path segment
+	// "?" to match on one character in a path segment
 	//  "**"
-	// to match any number of path segments, including none
+	// "**" to match any number of path segments, including none
 	//  "{}"
-	// to group conditions (e.g. `**/*.{ts,js}` matches all TypeScript and JavaScript files)
+	// "{}" to group conditions (e.g. `**/*.{ts,js}` matches all TypeScript and JavaScript files)
 	//  "[]"
-	// to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …)
+	// "[]" to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …)
 	//  "[!...]"
-	// to negate a range of characters to match in a path segment (e.g., `example.[!0-9]` to match on `example.a`, `example.b`, but not `example.0`)
+	// "[!...]" to negate a range of characters to match in a path segment (e.g., `example.[!0-9]` to match on `example.a`, `example.b`, but not `example.0`)
 	Pattern string `json:"pattern,omitempty"`
 }
 

callhierarchy.go

@@ -7,9 +7,11 @@ package protocol
 //
 // @since 3.16.0.
 type CallHierarchy struct {
-	// DynamicRegistration whether implementation supports dynamic registration. If this is set to "true"
-	// the client supports the new TextDocumentRegistrationOptions && StaticRegistrationOptions
-	// return value for the corresponding server capability as well.
+	// DynamicRegistration whether implementation supports dynamic registration.
+	//
+	// If this is set to "true" the client supports the new
+	// TextDocumentRegistrationOptions && StaticRegistrationOptions return
+	// value for the corresponding server capability as well.
 	DynamicRegistration bool `json:"dynamicRegistration,omitempty"`
 }
 

diagnostics.go

@@ -83,6 +83,14 @@ func (d DiagnosticSeverity) String() string {
 	}
 }
 
+// CodeDescription is the structure to capture a description for an error code.
+//
+// @since 3.16.0.
+type CodeDescription struct {
+	// Href an URI to open with more information about the diagnostic error.
+	Href URI `json:"href"`
+}
+
 // DiagnosticTag is the diagnostic tags.
 //
 // @since 3.15.0.
@@ -126,7 +134,7 @@ type DiagnosticRelatedInformation struct {
 	Message string `json:"message"`
 }
 
-// PublishDiagnosticsParams represents a params of PublishDiagnostics Notification.
+// PublishDiagnosticsParams represents a params of PublishDiagnostics notification.
 type PublishDiagnosticsParams struct {
 	// URI is the URI for which diagnostic information is reported.
 	URI DocumentURI `json:"uri"`

general.go

@@ -29,7 +29,7 @@ type ClientInfo struct {
 	Version string `json:"version,omitempty"`
 }
 
-// InitializeParams params of Initialize Request.
+// InitializeParams params of Initialize request.
 type InitializeParams struct {
 	WorkDoneProgressParams
 
@@ -232,7 +232,7 @@ type FileDelete struct {
 	URI string `json:"uri"`
 }
 
-// DocumentHighlightParams params of DocumentHighlight Request.
+// DocumentHighlightParams params of DocumentHighlight request.
 //
 // @since 3.15.0.
 type DocumentHighlightParams struct {
@@ -241,7 +241,7 @@ type DocumentHighlightParams struct {
 	PartialResultParams
 }
 
-// DeclarationParams params of Declaration Request.
+// DeclarationParams params of Declaration request.
 //
 // @since 3.15.0.
 type DeclarationParams struct {
@@ -250,7 +250,7 @@ type DeclarationParams struct {
 	PartialResultParams
 }
 
-// DefinitionParams params of Definition Request.
+// DefinitionParams params of Definition request.
 //
 // @since 3.15.0.
 type DefinitionParams struct {
@@ -259,7 +259,7 @@ type DefinitionParams struct {
 	PartialResultParams
 }
 
-// TypeDefinitionParams params of TypeDefinition Request.
+// TypeDefinitionParams params of TypeDefinition request.
 //
 // @since 3.15.0.
 type TypeDefinitionParams struct {
@@ -268,7 +268,7 @@ type TypeDefinitionParams struct {
 	PartialResultParams
 }
 
-// ImplementationParams params of Implementation Request.
+// ImplementationParams params of Implementation request.
 //
 // @since 3.15.0.
 type ImplementationParams struct {
@@ -454,7 +454,7 @@ type DocumentLinkRegistrationOptions struct {
 	ResolveProvider bool `json:"resolveProvider,omitempty"`
 }
 
-// InitializedParams params of Initialized Notification.
+// InitializedParams params of Initialized notification.
 type InitializedParams struct{}
 
 // WorkspaceFolders represents a slice of WorkspaceFolder.

language.go

@@ -7,7 +7,7 @@ import (
 	"strconv"
 )
 
-// CompletionParams params of Completion Request.
+// CompletionParams params of Completion request.
 type CompletionParams struct {
 	TextDocumentPositionParams
 	WorkDoneProgressParams
@@ -422,7 +422,7 @@ type CompletionRegistrationOptions struct {
 	ResolveProvider bool `json:"resolveProvider,omitempty"`
 }
 
-// HoverParams params of Hover Request.
+// HoverParams params of Hover request.
 //
 // @since 3.15.0.
 type HoverParams struct {
@@ -440,7 +440,7 @@ type Hover struct {
 	Range *Range `json:"range,omitempty"`
 }
 
-// SignatureHelpParams params of SignatureHelp Request.
+// SignatureHelpParams params of SignatureHelp request.
 //
 // @since 3.15.0.
 type SignatureHelpParams struct {
@@ -596,7 +596,7 @@ type SignatureHelpRegistrationOptions struct {
 	TriggerCharacters []string `json:"triggerCharacters,omitempty"`
 }
 
-// ReferenceParams params of References Request.
+// ReferenceParams params of References request.
 //
 // @since 3.15.0.
 type ReferenceParams struct {
@@ -653,7 +653,7 @@ func (k DocumentHighlightKind) String() string {
 	}
 }
 
-// DocumentSymbolParams params of Document Symbols Request.
+// DocumentSymbolParams params of Document Symbols request.
 type DocumentSymbolParams struct {
 	WorkDoneProgressParams
 	PartialResultParams
@@ -1037,7 +1037,7 @@ type CodeActionRegistrationOptions struct {
 	CodeActionOptions
 }
 
-// CodeLensParams params of Code Lens Request.
+// CodeLensParams params of Code Lens request.
 type CodeLensParams struct {
 	WorkDoneProgressParams
 	PartialResultParams
@@ -1071,7 +1071,7 @@ type CodeLensRegistrationOptions struct {
 	ResolveProvider bool `json:"resolveProvider,omitempty"`
 }
 
-// DocumentLinkParams params of Document Link Request.
+// DocumentLinkParams params of Document Link request.
 type DocumentLinkParams struct {
 	WorkDoneProgressParams
 	PartialResultParams
@@ -1103,7 +1103,7 @@ type DocumentLink struct {
 	Data interface{} `json:"data,omitempty"`
 }
 
-// DocumentColorParams params of Document Color Request.
+// DocumentColorParams params of Document Color request.
 type DocumentColorParams struct {
 	WorkDoneProgressParams
 	PartialResultParams
@@ -1112,7 +1112,7 @@ type DocumentColorParams struct {
 	TextDocument TextDocumentIdentifier `json:"textDocument"`
 }
 
-// ColorInformation response of Document Color Request.
+// ColorInformation response of Document Color request.
 type ColorInformation struct {
 	// Range is the range in the document where this color appears.
 	Range Range `json:"range"`
@@ -1136,7 +1136,7 @@ type Color struct {
 	Red float64 `json:"red"`
 }
 
-// ColorPresentationParams params of Color Presentation Request.
+// ColorPresentationParams params of Color Presentation request.
 type ColorPresentationParams struct {
 	WorkDoneProgressParams
 	PartialResultParams
@@ -1151,7 +1151,7 @@ type ColorPresentationParams struct {
 	Range Range `json:"range"`
 }
 
-// ColorPresentation response of Color Presentation Request.
+// ColorPresentation response of Color Presentation request.
 type ColorPresentation struct {
 	// Label is the label of this color presentation. It will be shown on the color
 	// picker header. By default this is also the text that is inserted when selecting
@@ -1167,7 +1167,7 @@ type ColorPresentation struct {
 	AdditionalTextEdits []TextEdit `json:"additionalTextEdits,omitempty"`
 }
 
-// DocumentFormattingParams params of Document Formatting Request.
+// DocumentFormattingParams params of Document Formatting request.
 type DocumentFormattingParams struct {
 	WorkDoneProgressParams
 
@@ -1205,7 +1205,7 @@ type FormattingOptions struct {
 	Key map[string]interface{} `json:"key,omitempty"` // bool | int32 | string
 }
 
-// DocumentRangeFormattingParams params of Document Range Formatting Request.
+// DocumentRangeFormattingParams params of Document Range Formatting request.
 type DocumentRangeFormattingParams struct {
 	WorkDoneProgressParams
 
@@ -1219,7 +1219,7 @@ type DocumentRangeFormattingParams struct {
 	Options FormattingOptions `json:"options"`
 }
 
-// DocumentOnTypeFormattingParams params of Document on Type Formatting Request.
+// DocumentOnTypeFormattingParams params of Document on Type Formatting request.
 type DocumentOnTypeFormattingParams struct {
 	// TextDocument is the document to format.
 	TextDocument TextDocumentIdentifier `json:"textDocument"`
@@ -1245,7 +1245,7 @@ type DocumentOnTypeFormattingRegistrationOptions struct {
 	MoreTriggerCharacter []string `json:"moreTriggerCharacter"`
 }
 
-// RenameParams params of Rename Request.
+// RenameParams params of Rename request.
 type RenameParams struct {
 	TextDocumentPositionParams
 	PartialResultParams
@@ -1271,7 +1271,7 @@ type PrepareRenameParams struct {
 	TextDocumentPositionParams
 }
 
-// FoldingRangeParams params of Folding Range Request.
+// FoldingRangeParams params of Folding Range request.
 type FoldingRangeParams struct {
 	TextDocumentPositionParams
 	PartialResultParams

progress.go

@@ -10,9 +10,14 @@ type WorkDoneProgressKind string
 
 // list of WorkDoneProgressKind.
 const (
-	WorkDoneProgressKindBegin  WorkDoneProgressKind = "begin"
+	// WorkDoneProgressKindBegin kind of WorkDoneProgressBegin.
+	WorkDoneProgressKindBegin WorkDoneProgressKind = "begin"
+
+	// WorkDoneProgressKindReport kind of WorkDoneProgressReport.
 	WorkDoneProgressKindReport WorkDoneProgressKind = "report"
-	WorkDoneProgressKindEnd    WorkDoneProgressKind = "end"
+
+	// WorkDoneProgressKindEnd kind of WorkDoneProgressEnd.
+	WorkDoneProgressKindEnd WorkDoneProgressKind = "end"
 )
 
 // WorkDoneProgressBegin is the to start progress reporting a "$/progress" notification.

semantic_token.go

@@ -8,6 +8,7 @@ package protocol
 // @since 3.16.0.
 type SemanticTokenTypes string
 
+// list of SemanticTokenTypes.
 const (
 	SemanticTokenNamespace SemanticTokenTypes = "namespace"
 
@@ -41,6 +42,7 @@ const (
 // @since 3.16.0.
 type SemanticTokenModifiers string
 
+// list of SemanticTokenModifiers.
 const (
 	SemanticTokenModifierDeclaration    SemanticTokenModifiers = "declaration"
 	SemanticTokenModifierDefinition     SemanticTokenModifiers = "definition"

text.go

@@ -7,13 +7,13 @@ import (
 	"strconv"
 )
 
-// DidOpenTextDocumentParams params of DidOpenTextDocument Notification.
+// DidOpenTextDocumentParams params of DidOpenTextDocument notification.
 type DidOpenTextDocumentParams struct {
 	// TextDocument is the document that was opened.
 	TextDocument TextDocumentItem `json:"textDocument"`
 }
 
-// DidChangeTextDocumentParams params of DidChangeTextDocument Notification.
+// DidChangeTextDocumentParams params of DidChangeTextDocument notification.
 type DidChangeTextDocumentParams struct {
 	// TextDocument is the document that did change. The version number points
 	// to the version after all provided content changes have
@@ -73,7 +73,7 @@ type WillSaveTextDocumentParams struct {
 	Reason TextDocumentSaveReason `json:"reason,omitempty"`
 }
 
-// DidSaveTextDocumentParams params of DidSaveTextDocument Notification.
+// DidSaveTextDocumentParams params of DidSaveTextDocument notification.
 type DidSaveTextDocumentParams struct {
 	// Text optional the content when saved. Depends on the includeText value
 	// when the save notification was requested.
@@ -104,7 +104,7 @@ type TextDocumentSaveRegistrationOptions struct {
 	IncludeText bool `json:"includeText,omitempty"`
 }
 
-// DidCloseTextDocumentParams params of DidCloseTextDocument Notification.
+// DidCloseTextDocumentParams params of DidCloseTextDocument notification.
 type DidCloseTextDocumentParams struct {
 	// TextDocument the document that was closed.
 	TextDocument TextDocumentIdentifier `json:"textDocument"`

window.go

@@ -5,7 +5,7 @@ package protocol
 
 import "strconv"
 
-// ShowMessageParams params of ShowMessage Notification.
+// ShowMessageParams params of ShowMessage notification.
 type ShowMessageParams struct {
 	// Message is the actual message.
 	Message string `json:"message"`
@@ -67,7 +67,7 @@ func ToMessageType(level string) MessageType {
 	return mt
 }
 
-// ShowMessageRequestParams params of ShowMessage Request.
+// ShowMessageRequestParams params of ShowMessage request.
 type ShowMessageRequestParams struct {
 	// Actions is the message action items to present.
 	Actions []MessageActionItem `json:"actions"`
@@ -85,7 +85,7 @@ type MessageActionItem struct {
 	Title string `json:"title"`
 }
 
-// LogMessageParams params of LogMessage Notification.
+// LogMessageParams params of LogMessage notification.
 type LogMessageParams struct {
 	// Message is the actual message
 	Message string `json:"message"`