You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
221 lines
9.3 KiB
221 lines
9.3 KiB
3 years ago
|
<!doctype html>
|
||
|
|
<html class="default no-js">
|
||
|
|
<head>
|
||
|
|
<meta charset="utf-8">
|
||
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||
|
|
<title>CommentingRangeProvider | Vscode Extension Api</title>
|
||
|
|
<meta name="description" content="Documentation for Vscode Extension Api">
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
|
|
<link rel="stylesheet" href="../assets/css/main.css">
|
||
|
|
<script async src="../assets/js/search.js" id="search-script"></script>
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<header>
|
||
|
|
<div class="tsd-page-toolbar">
|
||
|
|
<div class="container">
|
||
|
|
<div class="table-wrap">
|
||
|
|
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||
|
|
<div class="field">
|
||
|
|
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
||
|
|
<input id="tsd-search-field" type="text" />
|
||
|
|
</div>
|
||
|
|
<ul class="results">
|
||
|
|
<li class="state loading">Preparing search index...</li>
|
||
|
|
<li class="state failure">The search index is not available</li>
|
||
|
|
</ul>
|
||
|
|
<a href="../index.html" class="title">Vscode Extension Api</a>
|
||
|
|
</div>
|
||
|
|
<div class="table-cell" id="tsd-widgets">
|
||
|
|
<div id="tsd-filter">
|
||
|
|
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
||
|
|
<div class="tsd-filter-group">
|
||
|
|
<div class="tsd-select" id="tsd-filter-visibility">
|
||
|
|
<span class="tsd-select-label">All</span>
|
||
|
|
<ul class="tsd-select-list">
|
||
|
|
<li data-value="public">Public</li>
|
||
|
|
<li data-value="protected">Public/Protected</li>
|
||
|
|
<li data-value="private" class="selected">All</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<input type="checkbox" id="tsd-filter-inherited" checked />
|
||
|
|
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
||
|
|
<input type="checkbox" id="tsd-filter-externals" checked />
|
||
|
|
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="tsd-page-title">
|
||
|
|
<div class="container">
|
||
|
|
<ul class="tsd-breadcrumb">
|
||
|
|
<li>
|
||
|
|
<a href="../modules.html">Vscode Extension Api</a>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<a href="../modules/vscode.html">vscode</a>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<a href="vscode.CommentingRangeProvider.html">CommentingRangeProvider</a>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<h1>Interface CommentingRangeProvider</h1>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</header>
|
||
|
|
<div class="container container-main">
|
||
|
|
<div class="row">
|
||
|
|
<div class="col-8 col-content">
|
||
|
|
<section class="tsd-panel tsd-comment">
|
||
|
|
<div class="tsd-comment tsd-typography">
|
||
|
|
<div class="lead">
|
||
|
|
<p>Commenting range provider for a <a href="vscode.CommentController.html">comment controller</a>.</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
<section class="tsd-panel tsd-hierarchy">
|
||
|
|
<h3>Hierarchy</h3>
|
||
|
|
<ul class="tsd-hierarchy">
|
||
|
|
<li>
|
||
|
|
<span class="target">CommentingRangeProvider</span>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</section>
|
||
|
|
<section class="tsd-panel-group tsd-index-group">
|
||
|
|
<h2>Index</h2>
|
||
|
|
<section class="tsd-panel tsd-index-panel">
|
||
|
|
<div class="tsd-index-content">
|
||
|
|
<section class="tsd-index-section ">
|
||
|
|
<h3>Methods</h3>
|
||
|
|
<ul class="tsd-index-list">
|
||
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="vscode.CommentingRangeProvider.html#provideCommentingRanges" class="tsd-kind-icon">provide<wbr>Commenting<wbr>Ranges</a></li>
|
||
|
|
</ul>
|
||
|
|
</section>
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
</section>
|
||
|
|
<section class="tsd-panel-group tsd-member-group ">
|
||
|
|
<h2>Methods</h2>
|
||
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||
|
|
<a name="provideCommentingRanges" class="tsd-anchor"></a>
|
||
|
|
<h3>provide<wbr>Commenting<wbr>Ranges</h3>
|
||
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||
|
|
<li class="tsd-signature tsd-kind-icon">provide<wbr>Commenting<wbr>Ranges<span class="tsd-signature-symbol">(</span>document<span class="tsd-signature-symbol">: </span><a href="vscode.TextDocument.html" class="tsd-signature-type" data-tsd-kind="Interface">TextDocument</a>, token<span class="tsd-signature-symbol">: </span><a href="vscode.CancellationToken.html" class="tsd-signature-type" data-tsd-kind="Interface">CancellationToken</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/vscode.html#ProviderResult" class="tsd-signature-type" data-tsd-kind="Type alias">ProviderResult</a><span class="tsd-signature-symbol"><</span><a href="../classes/vscode.Range.html" class="tsd-signature-type" data-tsd-kind="Class">Range</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="tsd-descriptions">
|
||
|
|
<li class="tsd-description">
|
||
|
|
<aside class="tsd-sources">
|
||
|
|
<ul>
|
||
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-extension-api/blob/branch/vscode.d.ts#L13522">vscode.d.ts:13522</a></li>
|
||
|
|
</ul>
|
||
|
|
</aside>
|
||
|
|
<div class="tsd-comment tsd-typography">
|
||
|
|
<div class="lead">
|
||
|
|
<p>Provide a list of ranges which allow new comment threads creation or null for a given document</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
|
|
<ul class="tsd-parameters">
|
||
|
|
<li>
|
||
|
|
<h5>document: <a href="vscode.TextDocument.html" class="tsd-signature-type" data-tsd-kind="Interface">TextDocument</a></h5>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<h5>token: <a href="vscode.CancellationToken.html" class="tsd-signature-type" data-tsd-kind="Interface">CancellationToken</a></h5>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<h4 class="tsd-returns-title">Returns <a href="../modules/vscode.html#ProviderResult" class="tsd-signature-type" data-tsd-kind="Type alias">ProviderResult</a><span class="tsd-signature-symbol"><</span><a href="../classes/vscode.Range.html" class="tsd-signature-type" data-tsd-kind="Class">Range</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</section>
|
||
|
|
</section>
|
||
|
|
</div>
|
||
|
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||
|
|
<nav class="tsd-navigation primary">
|
||
|
|
<ul>
|
||
|
|
<li class=" ">
|
||
|
|
<a href="../modules.html">Exports</a>
|
||
|
|
</li>
|
||
|
|
<li class="current tsd-kind-namespace">
|
||
|
|
<a href="../modules/vscode.html">vscode</a>
|
||
|
|
<ul>
|
||
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
||
|
|
<a href="../modules/vscode.authentication.html">authentication</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
||
|
|
<a href="../modules/vscode.commands.html">commands</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
||
|
|
<a href="../modules/vscode.comments.html">comments</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
||
|
|
<a href="../modules/vscode.debug.html">debug</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
||
|
|
<a href="../modules/vscode.env.html">env</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
||
|
|
<a href="../modules/vscode.extensions.html">extensions</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
||
|
|
<a href="../modules/vscode.languages.html">languages</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
||
|
|
<a href="../modules/vscode.notebooks.html">notebooks</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
||
|
|
<a href="../modules/vscode.scm.html">scm</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
||
|
|
<a href="../modules/vscode.tasks.html">tasks</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
||
|
|
<a href="../modules/vscode.tests.html">tests</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
||
|
|
<a href="../modules/vscode.window.html">window</a>
|
||
|
|
</li>
|
||
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
||
|
|
<a href="../modules/vscode.workspace.html">workspace</a>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</nav>
|
||
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
||
|
|
<ul class="before-current">
|
||
|
|
</ul>
|
||
|
|
<ul class="current">
|
||
|
|
<li class="current tsd-kind-interface tsd-parent-kind-namespace">
|
||
|
|
<a href="vscode.CommentingRangeProvider.html" class="tsd-kind-icon">Commenting<wbr>Range<wbr>Provider</a>
|
||
|
|
<ul>
|
||
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||
|
|
<a href="vscode.CommentingRangeProvider.html#provideCommentingRanges" class="tsd-kind-icon">provide<wbr>Commenting<wbr>Ranges</a>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<ul class="after-current">
|
||
|
|
</ul>
|
||
|
|
</nav>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<footer class="with-border-bottom">
|
||
|
|
<div class="container">
|
||
|
|
<h2>Legend</h2>
|
||
|
|
<div class="tsd-legend-group">
|
||
|
|
<ul class="tsd-legend">
|
||
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</footer>
|
||
|
|
<div class="container tsd-generator">
|
||
|
|
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
||
|
|
</div>
|
||
|
|
<div class="overlay"></div>
|
||
|
|
<script src="../assets/js/main.js"></script>
|
||
|
|
</body>
|
||
|
|
</html>
|