package
7.2.4
Repository: https://github.com/caixw/apidoc.git
Documentation: pkg.go.dev

# Functions

BuildAPIDocOutline 根据 ast.APIDoc 构建 APIDoc 如果 doc 不是一个有效的文档内容,比如是零值,则返回 nil。 如果是 doc.APIs 中的某一个元素的 path 未必须,则会忽略此记录的显示。.
BuildFoldingRange 根据参数构建 FoldingRange 实例.
BuildLogTrace 生成 logTrace 对象.
IsValidTraceValue 是否是一个有效的 TraceValue.
NewPublishDiagnosticsParams 声明空的 PublishDiagnosticsParams 对象.

# Constants

CompletionItemKind 的各类枚举值.
CompletionItemKind 的各类枚举值.
CompletionItemKind 的各类枚举值.
CompletionItemKind 的各类枚举值.
CompletionItemKind 的各类枚举值.
CompletionItemKind 的各类枚举值.
CompletionItemKind 的各类枚举值.
CompletionItemKind 的各类枚举值.
CompletionItemKind 的各类枚举值.
CompletionItemKind 的各类枚举值.
CompletionItemKind 的各类枚举值.
CompletionItemKind 的各类枚举值.
CompletionItemKind 的各类枚举值.
CompletionItemKind 的各类枚举值.
CompletionItemKind 的各类枚举值.
CompletionItemKind 的各类枚举值.
CompletionItemKind 的各类枚举值.
CompletionItemKind 的各类枚举值.
CompletionItemKind 的各类枚举值.
CompletionItemKind 的各类枚举值.
CompletionItemKind 的各类枚举值.
CompletionItemKind 的各类枚举值.
CompletionItemKind 的各类枚举值.
CompletionItemKind 的各类枚举值.
CompletionItemKind 的各类枚举值.
CompletionItemTagDeprecated render a completion as obsolete, usually using a strike-out.
Completion was triggered by typing an identifier (24x7 code complete), manual invocation (e.g Ctrl+Space) or via API.
Completion was triggered by a trigger character specified by the `triggerCharacters` properties of the `CompletionRegistrationOptions`.
Completion was re-triggered as the current completion list is incomplete.
Reports an error.
Reports a hint.
Reports an information.
Reports a warning.
DiagnosticTagDeprecated deprecated or obsolete code.
DiagnosticTagUnnecessary unused or unnecessary code.
FailureHandlingKindAbort applying the workspace change is simply aborted if one of the changes provided fails.
FailureHandlingKindTextOnlyTransactional if the workspace edit contains only textual file changes they are executed transactionally.
FailureHandlingKindTransactional all operations are executed transactionally.
FailureHandlingKindUndo The client tries to undo the operations already executed.
Folding range for a comment.
Folding range for a imports or includes.
Folding range for a region (e.g.
The primary text to be inserted is treated as a plain string.
The primary text to be inserted is treated as a snippet.
MarkupKindMarkdown markdown is supported as a content format.
MarkupKindPlainText plain text is supported as a content format.
An error message.
An information message.
A log message.
A warning message.
ResourceOperationKindCreate supports creating new files and folders.
ResourceOperationKindDelete supports deleting existing files and folders.
ResourceOperationKindRename supports renaming existing files and folders.
TextDocumentSyncKindFull documents are synced by always sending the full content of the document.
TextDocumentSyncKindIncremental documents are synced by sending the full content on open.
TextDocumentSyncKindNone documents should not be synced at all.
TokenFormat支持的常量.
SetTraceParams.Value 可用的值.
SetTraceParams.Value 可用的值.
SetTraceParams.Value 可用的值.

# Structs

API 描述单个 API 的信息.
APIDocDetectParams apidoc/detect 的请求参数.
APIDocDetectResult apidoc/detect 的返回参数.
APIDocOutline 传递给客户端的文档摘要 这不是一个标准的 LSP 数据结构,由 apidoc 自定义, 用户由服务端向客户端发送当前的文档结构信息。.
APIDocServer 文档支持的服务器.
APIDocTag 文档支持的标签属性.
CancelParams The base protocol offers support for request cancellation https://microsoft.github.io/language-server-protocol/specifications/specification-current/#cancelRequest.
ClientCapabilities 客户端的兼容列表.
Command represents a reference to a command Provides a title which will be used to represent a command in the UI.
CompletionClientCapabilities 客户端有关自动完成所支持的功能定义.
CompletionContext contains additional information about the context in which a completion request is triggered.
CompletionItem completion items.
CompletionList represents a collection of [completion items](#CompletionItem) to be presented in the editor.
CompletionOptions 服务端返回的有关对自动完成支持性的描述.
CompletionParams textDocument/completion 的参数.
DefinitionClientCapabilities 客户端对 textDocument/definition 的支持情况.
DefinitionParams textDocument/definition 服务的客户端请求参数.
Diagnostic represents a diagnostic,such as a compiler error or warning.
DidChangeTextDocumentParams textDocument/didChange 的参数.
DidChangeWorkspaceFoldersParams workspace/didChangeWorkspaceFolders 参数.
DocumentFilter denotes a document through properties like language, scheme or pattern.
FoldingRange represents a folding range.
FoldingRangeClientCapabilities 定义客户对代码拆叠功能的支持情况.
FoldingRangeParams 由用户传递的 textDocument/foldingRange 参数.
Hover textDocument/hover 的返回结果.
HoverCapabilities 客户端有关 hover 功能的描述.
HoverParams textDocument/hover 发送的参数.
InitializationOptions 用户需要提交的自定义初始化参数.
InitializedParams initialized 服务传递的参数.
InitializeParams 初始化请求的参数.
InitializeResult initialize 服务的返回结构.
LogMessageParams window/logMessage 传递的参数.
LogTraceParams $/logTrace 服务端下发参数.
MarkupContent literal represents a string value which content is interpreted base on its kind flag.
PartialResultParams a parameter literal used to pass a partial result token.
PublishDiagnosticsClientCapabilities 客户端有关错误信息的支持情况定义.
PublishDiagnosticsParams textDocument/publishDiagnostics 事件发送的参数.
ReferenceClientCapabilities 客户端对 textDocument/references 的支持情况.
ReferenceParams textDocument/references 的请求参数.
SaveOptions Save options.
SemanticTokens textDocument/semanticTokens 返回参数.
SemanticTokensClientCapabilities 客户端的支持情况.
No description provided by the author
SemanticTokensOptions 服务端有关 SemanticTokens 的支持情况.
SemanticTokensParams textDocument/semanticTokens 入口参数.
SemanticTokensRegistrationOptions textDocument/semanticTokens/full 返回参数.
ServerCapabilities 服务端的兼容列表.
ServerCapabilitiesTextDocumentSyncOptions 服务端对文档同步的支持项.
ServerInfo 终端的信息,同时用于描述服务和客户端。 @since 3.15.0.
SetTraceParams $/setTrace 入口参数.
StaticRegistrationOptions static registration options to be returned in the initialize request.
TextDocumentClientCapabilities text document specific client capabilities.
TextDocumentContentChangeEvent an event describing a change to a text document.
TextDocumentIdentifier text documents are identified using a URI.
TextDocumentPositionParams a parameter literal used in requests to pass a text document and a position inside that document.
TextDocumentRegistrationOptions General text document registration options.
TextEdit a textual edit applicable to a text document.
VersionedTextDocumentIdentifier an identifier to denote a specific version of a text document.
WorkDoneProgressOptions options to signal work done progress support in server capabilities.
WorkDoneProgressParams a parameter literal used to pass a work done progress token.
WorkspaceClientCapabilities 客户有关 workspace 的支持情况.
WorkspaceEditClientCapabilities the capabilities of a workspace edit has evolved over the time.
WorkspaceFolder 项目文件夹.
WorkspaceFoldersChangeEvent the workspace folder change event.
WorkspaceFoldersServerCapabilities 服务端有关项目文件夹的支持情况.
WorkspaceProvider 服务端有关 workspace 的支持情况.

# Interfaces

ProgressToken type ProgressToken = number | string;.

# Type aliases

CompletionItemKind the kind of a completion entry.
CompletionItemTag are extra annotations that tweak the rendering of a completion item.
CompletionTriggerKind how a completion was triggered.
DiagnosticSeverity 错误级别.
DiagnosticTag the diagnostic tags.
DocumentSelector is the combination of one or more document filters.
FailureHandlingKind 定义出错后的处理方式.
InsertTextFormat defines whether the insert text in a completion item should be interpreted as plain text or a snippet.
MarkupKind describes the content type that a client supports in various result literals like `Hover`, `ParameterInfo` or `CompletionItem`.
MessageType 传递的消息类型.
ResourceOperationKind the kind of resource operations supported by the client.
TextDocumentSyncKind defines how the host (editor) should sync document changes to the language server.
TokenFormat the protocol defines an additional token format capability to allow future extensions of the format The only format that is currently specified is relative expressing that the tokens are described using relative positions.