@nikovirtala/projen-typedoc 0.0.0 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.jsii +78 -78
- package/API.md +83 -83
- package/README.md +10 -0
- package/docs/api/assets/search.js +1 -1
- package/docs/api/classes/TypeDoc.html +11 -11
- package/docs/api/enums/CommentStyle.html +3 -3
- package/docs/api/enums/EntryPointStrategy.html +6 -6
- package/docs/api/enums/LogLevel.html +3 -3
- package/docs/api/enums/Visibility.html +3 -3
- package/docs/api/functions/toJson_TypeDocConfiguration.html +1 -1
- package/docs/api/index.html +9 -1
- package/docs/api/interfaces/TypeDocConfiguration.html +94 -94
- package/docs/api/interfaces/TypeDocOptions.html +3 -3
- package/docs/api/interfaces/ValidationOptions.html +5 -5
- package/lib/index.js +3 -2
- package/lib/typedoc-config.d.ts +67 -67
- package/lib/typedoc-config.js +6 -6
- package/package.json +2 -2
- package/typedoc.jsonc +2 -1
- package/.amazonq/rules/standards.md +0 -320
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>TypeDocOptions | @nikovirtala/projen-typedoc</title><meta name="description" content="Documentation for @nikovirtala/projen-typedoc"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@nikovirtala/projen-typedoc</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">TypeDocOptions</a></li></ul><h1>Interface TypeDocOptions</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">TypeDocOptions</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#typedocconfig">typeDocConfig</a><span class="tsd-signature-symbol">?:</span> <a href="TypeDocConfiguration.html" class="tsd-signature-type tsd-kind-interface">TypeDocConfiguration</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#version">version</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>TypeDocOptions | @nikovirtala/projen-typedoc</title><meta name="description" content="Documentation for @nikovirtala/projen-typedoc"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@nikovirtala/projen-typedoc</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">TypeDocOptions</a></li></ul><h1>Interface TypeDocOptions</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">TypeDocOptions</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#typedocconfig">typeDocConfig</a><span class="tsd-signature-symbol">?:</span> <a href="TypeDocConfiguration.html" class="tsd-signature-type tsd-kind-interface">TypeDocConfiguration</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#version">version</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#typedocconfig" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type<wbr/>Doc<wbr/>Config?</span></a>
|
|
2
2
|
<a href="#version" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>version?</span></a>
|
|
3
3
|
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="typedocconfig"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>type<wbr/>Doc<wbr/>Config</span><a href="#typedocconfig" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">typeDocConfig</span><span class="tsd-signature-symbol">?:</span> <a href="TypeDocConfiguration.html" class="tsd-signature-type tsd-kind-interface">TypeDocConfiguration</a></div><div class="tsd-comment tsd-typography"><p>Full TypeDoc configuration</p>
|
|
4
4
|
<p>This configuration will be merged with the default configuration</p>
|
|
5
|
-
</div
|
|
5
|
+
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="version"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>version</span><a href="#version" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">version</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Version of TypeDoc to use</p>
|
|
6
6
|
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default">Default<a href="#default" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">"^0.28"</span>
|
|
7
7
|
</code><button type="button">Copy</button></pre>
|
|
8
8
|
|
|
9
|
-
</div></div
|
|
9
|
+
</div></div></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#typedocconfig"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type<wbr/>Doc<wbr/>Config</span></a><a href="#version"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>version</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@nikovirtala/projen-typedoc</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ValidationOptions | @nikovirtala/projen-typedoc</title><meta name="description" content="Documentation for @nikovirtala/projen-typedoc"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@nikovirtala/projen-typedoc</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">ValidationOptions</a></li></ul><h1>Interface ValidationOptions</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Validation options</p>
|
|
2
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see">See<a href="#see" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="https://typedoc.org/
|
|
3
|
-
</div></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ValidationOptions</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#invalidlink">invalidLink</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#notdocumented">notDocumented</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#notexported">notExported</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><
|
|
2
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see">See<a href="#see" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="https://typedoc.org/documents/Options.Validation.html">https://typedoc.org/documents/Options.Validation.html</a></p>
|
|
3
|
+
</div></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ValidationOptions</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#invalidlink">invalidLink</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#notdocumented">notDocumented</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#notexported">notExported</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#invalidlink" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>invalid<wbr/>Link?</span></a>
|
|
4
4
|
<a href="#notdocumented" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>not<wbr/>Documented?</span></a>
|
|
5
5
|
<a href="#notexported" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>not<wbr/>Exported?</span></a>
|
|
6
6
|
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="invalidlink"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>invalid<wbr/>Link</span><a href="#invalidlink" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">invalidLink</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>If set, TypeDoc will produce warnings about @link tags which will produce broken links</p>
|
|
7
|
-
</div
|
|
8
|
-
</div
|
|
9
|
-
</div
|
|
7
|
+
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="notdocumented"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>not<wbr/>Documented</span><a href="#notdocumented" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">notDocumented</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>If set, TypeDoc will produce warnings when an exported symbol is not documented</p>
|
|
8
|
+
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="notexported"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>not<wbr/>Exported</span><a href="#notexported" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">notExported</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>If set, TypeDoc will produce warnings when a symbol is referenced by the documentation</p>
|
|
9
|
+
</div></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#invalidlink"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>invalid<wbr/>Link</span></a><a href="#notdocumented"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>not<wbr/>Documented</span></a><a href="#notexported"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>not<wbr/>Exported</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@nikovirtala/projen-typedoc</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
package/lib/index.js
CHANGED
|
@@ -29,6 +29,7 @@ const DEFAULT_CONFIG = {
|
|
|
29
29
|
out: "docs/api",
|
|
30
30
|
exclude: ["**/*.test.ts"],
|
|
31
31
|
excludePrivate: true,
|
|
32
|
+
disableSources: true,
|
|
32
33
|
};
|
|
33
34
|
/**
|
|
34
35
|
* TypeDoc component for projen projects
|
|
@@ -65,6 +66,6 @@ class TypeDoc extends component_1.Component {
|
|
|
65
66
|
}
|
|
66
67
|
exports.TypeDoc = TypeDoc;
|
|
67
68
|
_a = JSII_RTTI_SYMBOL_1;
|
|
68
|
-
TypeDoc[_a] = { fqn: "@nikovirtala/projen-typedoc.TypeDoc", version: "
|
|
69
|
+
TypeDoc[_a] = { fqn: "@nikovirtala/projen-typedoc.TypeDoc", version: "1.0.0" };
|
|
69
70
|
__exportStar(require("./typedoc-config"), exports);
|
|
70
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
71
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7Ozs7OztBQUFBLG9EQUFpRDtBQUVqRCwwQ0FBMkM7QUFHM0MsMENBQTRDO0FBQzVDLHFEQUE4RztBQUU5Rzs7R0FFRztBQUNILE1BQU0sY0FBYyxHQUF5QjtJQUN6QyxrQkFBa0IsRUFBRSxtQ0FBa0IsQ0FBQyxNQUFNO0lBQzdDLEdBQUcsRUFBRSxVQUFVO0lBQ2YsT0FBTyxFQUFFLENBQUMsY0FBYyxDQUFDO0lBQ3pCLGNBQWMsRUFBRSxJQUFJO0lBQ3BCLGNBQWMsRUFBRSxJQUFJO0NBQ3ZCLENBQUM7QUFrQkY7O0dBRUc7QUFDSCxNQUFhLE9BQVEsU0FBUSxxQkFBUztJQUMzQixNQUFNLENBQUMsRUFBRSxDQUFDLE9BQWdCO1FBQzdCLE1BQU0sU0FBUyxHQUFHLENBQUMsQ0FBWSxFQUFnQixFQUFFLENBQUMsQ0FBQyxZQUFZLE9BQU8sQ0FBQztRQUN2RSxPQUFPLE9BQU8sQ0FBQyxVQUFVLENBQUMsSUFBSSxDQUFDLFNBQVMsQ0FBQyxDQUFDO0lBQzlDLENBQUM7SUFjRCxZQUFZLE9BQW9CLEVBQUUsVUFBMEIsRUFBRTtRQUMxRCxLQUFLLENBQUMsT0FBTyxDQUFDLENBQUM7UUFFZixNQUFNLE9BQU8sR0FBRyxTQUFTLENBQUM7UUFDMUIsT0FBTyxDQUFDLFVBQVUsQ0FBQyxHQUFHLE9BQU8sSUFBSSxPQUFPLENBQUMsT0FBTyxJQUFJLE9BQU8sRUFBRSxDQUFDLENBQUM7UUFFL0Q7O1dBRUc7UUFDSCxJQUFJLENBQUMsb0JBQW9CLEdBQUcsSUFBQSxnQkFBUyxFQUNqQyxDQUFDLElBQUEsNENBQTJCLEVBQUMsY0FBYyxDQUFDLEVBQUUsSUFBQSw0Q0FBMkIsRUFBQyxPQUFPLENBQUMsYUFBYSxJQUFJLEVBQUUsQ0FBQyxDQUFDLEVBQ3ZHLEVBQUUsV0FBVyxFQUFFLElBQUksRUFBRSxDQUN4QixDQUFDO1FBRUYsSUFBSSxDQUFDLElBQUksR0FBRyxJQUFJLGVBQVEsQ0FBQyxJQUFJLEVBQUUsZUFBZSxFQUFFO1lBQzVDLEdBQUcsRUFBRSxJQUFJLENBQUMsb0JBQW9CO1lBQzlCLGFBQWEsRUFBRSxJQUFJO1lBQ25CLE1BQU0sRUFBRSxJQUFJO1lBQ1osUUFBUSxFQUFFLEtBQUs7U0FDbEIsQ0FBQyxDQUFDO1FBRUgsSUFBSSxDQUFDLElBQUksR0FBRyxPQUFPLENBQUMsT0FBTyxDQUFDLFNBQVMsRUFBRTtZQUNuQyxXQUFXLEVBQUUsZ0NBQWdDO1lBQzdDLEtBQUssRUFBRTtnQkFDSDtvQkFDSSxJQUFJLEVBQUUsU0FBUztpQkFDbEI7YUFDSjtTQUNKLENBQUMsQ0FBQztRQUNILE9BQU8sQ0FBQyxRQUFRLENBQUMsS0FBSyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQztJQUN0QyxDQUFDOztBQWhETCwwQkFpREM7OztBQUVELG1EQUFpQyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IENvbXBvbmVudCB9IGZyb20gXCJwcm9qZW4vbGliL2NvbXBvbmVudFwiO1xuaW1wb3J0IHR5cGUgeyBOb2RlUHJvamVjdCB9IGZyb20gXCJwcm9qZW4vbGliL2phdmFzY3JpcHQvbm9kZS1wcm9qZWN0XCI7XG5pbXBvcnQgeyBKc29uRmlsZSB9IGZyb20gXCJwcm9qZW4vbGliL2pzb25cIjtcbmltcG9ydCB0eXBlIHsgUHJvamVjdCB9IGZyb20gXCJwcm9qZW4vbGliL3Byb2plY3RcIjtcbmltcG9ydCB0eXBlIHsgVGFzayB9IGZyb20gXCJwcm9qZW4vbGliL3Rhc2tcIjtcbmltcG9ydCB7IGRlZXBNZXJnZSB9IGZyb20gXCJwcm9qZW4vbGliL3V0aWxcIjtcbmltcG9ydCB7IEVudHJ5UG9pbnRTdHJhdGVneSwgdHlwZSBUeXBlRG9jQ29uZmlndXJhdGlvbiwgdG9Kc29uX1R5cGVEb2NDb25maWd1cmF0aW9uIH0gZnJvbSBcIi4vdHlwZWRvYy1jb25maWdcIjtcblxuLyoqXG4gKiBEZWZhdWx0IFR5cGVEb2MgY29uZmlndXJhdGlvblxuICovXG5jb25zdCBERUZBVUxUX0NPTkZJRzogVHlwZURvY0NvbmZpZ3VyYXRpb24gPSB7XG4gICAgZW50cnlQb2ludFN0cmF0ZWd5OiBFbnRyeVBvaW50U3RyYXRlZ3kuRVhQQU5ELFxuICAgIG91dDogXCJkb2NzL2FwaVwiLFxuICAgIGV4Y2x1ZGU6IFtcIioqLyoudGVzdC50c1wiXSxcbiAgICBleGNsdWRlUHJpdmF0ZTogdHJ1ZSxcbiAgICBkaXNhYmxlU291cmNlczogdHJ1ZSxcbn07XG5cbmV4cG9ydCBpbnRlcmZhY2UgVHlwZURvY09wdGlvbnMge1xuICAgIC8qKlxuICAgICAqIFZlcnNpb24gb2YgVHlwZURvYyB0byB1c2VcbiAgICAgKlxuICAgICAqIEBkZWZhdWx0IFwiXjAuMjhcIlxuICAgICAqL1xuICAgIHJlYWRvbmx5IHZlcnNpb24/OiBzdHJpbmc7XG5cbiAgICAvKipcbiAgICAgKiBGdWxsIFR5cGVEb2MgY29uZmlndXJhdGlvblxuICAgICAqXG4gICAgICogVGhpcyBjb25maWd1cmF0aW9uIHdpbGwgYmUgbWVyZ2VkIHdpdGggdGhlIGRlZmF1bHQgY29uZmlndXJhdGlvblxuICAgICAqL1xuICAgIHJlYWRvbmx5IHR5cGVEb2NDb25maWc/OiBUeXBlRG9jQ29uZmlndXJhdGlvbjtcbn1cblxuLyoqXG4gKiBUeXBlRG9jIGNvbXBvbmVudCBmb3IgcHJvamVuIHByb2plY3RzXG4gKi9cbmV4cG9ydCBjbGFzcyBUeXBlRG9jIGV4dGVuZHMgQ29tcG9uZW50IHtcbiAgICBwdWJsaWMgc3RhdGljIG9mKHByb2plY3Q6IFByb2plY3QpOiBUeXBlRG9jIHwgdW5kZWZpbmVkIHtcbiAgICAgICAgY29uc3QgaXNUeXBlRG9jID0gKGM6IENvbXBvbmVudCk6IGMgaXMgVHlwZURvYyA9PiBjIGluc3RhbmNlb2YgVHlwZURvYztcbiAgICAgICAgcmV0dXJuIHByb2plY3QuY29tcG9uZW50cy5maW5kKGlzVHlwZURvYyk7XG4gICAgfVxuXG4gICAgcHJpdmF0ZSByZWFkb25seSB0eXBlRG9jQ29uZmlndXJhdGlvbjogUmVjb3JkPHN0cmluZywgdW5rbm93bj47XG5cbiAgICAvKipcbiAgICAgKiBUeXBlRG9jIHRhc2tcbiAgICAgKi9cbiAgICBwdWJsaWMgcmVhZG9ubHkgdGFzazogVGFzaztcblxuICAgIC8qKlxuICAgICAqIFR5cGVEb2MgY29uZmlndXJhdGlvbiBmaWxlXG4gICAgICovXG4gICAgcHVibGljIHJlYWRvbmx5IGZpbGU6IEpzb25GaWxlO1xuXG4gICAgY29uc3RydWN0b3IocHJvamVjdDogTm9kZVByb2plY3QsIG9wdGlvbnM6IFR5cGVEb2NPcHRpb25zID0ge30pIHtcbiAgICAgICAgc3VwZXIocHJvamVjdCk7XG5cbiAgICAgICAgY29uc3QgdHlwZWRvYyA9IFwidHlwZWRvY1wiO1xuICAgICAgICBwcm9qZWN0LmFkZERldkRlcHMoYCR7dHlwZWRvY31AJHtvcHRpb25zLnZlcnNpb24gPz8gXCJeMC4yOFwifWApO1xuXG4gICAgICAgIC8qXG4gICAgICAgICAqIE1lcmdlIGRlZmF1bHQgY29uZmlndXJhdGlvbiB3aXRoIHVzZXItcHJvdmlkZWQgY29uZmlndXJhdGlvblxuICAgICAgICAgKi9cbiAgICAgICAgdGhpcy50eXBlRG9jQ29uZmlndXJhdGlvbiA9IGRlZXBNZXJnZShcbiAgICAgICAgICAgIFt0b0pzb25fVHlwZURvY0NvbmZpZ3VyYXRpb24oREVGQVVMVF9DT05GSUcpLCB0b0pzb25fVHlwZURvY0NvbmZpZ3VyYXRpb24ob3B0aW9ucy50eXBlRG9jQ29uZmlnID8/IHt9KV0sXG4gICAgICAgICAgICB7IG1lcmdlQXJyYXlzOiB0cnVlIH0sXG4gICAgICAgICk7XG5cbiAgICAgICAgdGhpcy5maWxlID0gbmV3IEpzb25GaWxlKHRoaXMsIFwidHlwZWRvYy5qc29uY1wiLCB7XG4gICAgICAgICAgICBvYmo6IHRoaXMudHlwZURvY0NvbmZpZ3VyYXRpb24sXG4gICAgICAgICAgICBhbGxvd0NvbW1lbnRzOiB0cnVlLFxuICAgICAgICAgICAgbWFya2VyOiB0cnVlLFxuICAgICAgICAgICAgcmVhZG9ubHk6IGZhbHNlLFxuICAgICAgICB9KTtcblxuICAgICAgICB0aGlzLnRhc2sgPSBwcm9qZWN0LmFkZFRhc2soXCJ0eXBlZG9jXCIsIHtcbiAgICAgICAgICAgIGRlc2NyaXB0aW9uOiBcIkdlbmVyYXRlIFR5cGVEb2MgZG9jdW1lbnRhdGlvblwiLFxuICAgICAgICAgICAgc3RlcHM6IFtcbiAgICAgICAgICAgICAgICB7XG4gICAgICAgICAgICAgICAgICAgIGV4ZWM6IFwidHlwZWRvY1wiLFxuICAgICAgICAgICAgICAgIH0sXG4gICAgICAgICAgICBdLFxuICAgICAgICB9KTtcbiAgICAgICAgcHJvamVjdC50ZXN0VGFzay5zcGF3bih0aGlzLnRhc2spO1xuICAgIH1cbn1cblxuZXhwb3J0ICogZnJvbSBcIi4vdHlwZWRvYy1jb25maWdcIjtcbiJdfQ==
|
package/lib/typedoc-config.d.ts
CHANGED
|
@@ -7,277 +7,277 @@ export interface TypeDocConfiguration {
|
|
|
7
7
|
/**
|
|
8
8
|
* Specifies the entry points to be documented by TypeDoc.
|
|
9
9
|
*
|
|
10
|
-
* @see https://typedoc.org/
|
|
10
|
+
* @see https://typedoc.org/documents/Options.Input.html#entrypoints
|
|
11
11
|
*/
|
|
12
12
|
readonly entryPoints?: string[];
|
|
13
13
|
/**
|
|
14
14
|
* Specifies the strategy to be used to convert entry points into documentation.
|
|
15
15
|
*
|
|
16
|
-
* @see https://typedoc.org/
|
|
16
|
+
* @see https://typedoc.org/documents/Options.Input.html#entrypointstrategy
|
|
17
17
|
*/
|
|
18
18
|
readonly entryPointStrategy?: EntryPointStrategy;
|
|
19
19
|
/**
|
|
20
20
|
* Define patterns to be excluded when expanding directories.
|
|
21
21
|
*
|
|
22
|
-
* @see https://typedoc.org/
|
|
22
|
+
* @see https://typedoc.org/documents/Options.Input.html#exclude
|
|
23
23
|
*/
|
|
24
24
|
readonly exclude?: string[];
|
|
25
25
|
/**
|
|
26
26
|
* Prevent externally resolved symbols from being documented.
|
|
27
27
|
*
|
|
28
|
-
* @see https://typedoc.org/
|
|
28
|
+
* @see https://typedoc.org/documents/Options.Input.html#excludeexternals
|
|
29
29
|
*/
|
|
30
30
|
readonly excludeExternals?: boolean;
|
|
31
31
|
/**
|
|
32
32
|
* Prevent private members from being included in the generated documentation.
|
|
33
33
|
*
|
|
34
|
-
* @see https://typedoc.org/
|
|
34
|
+
* @see https://typedoc.org/documents/Options.Input.html#excludeprivate
|
|
35
35
|
*/
|
|
36
36
|
readonly excludePrivate?: boolean;
|
|
37
37
|
/**
|
|
38
38
|
* Prevent protected members from being included in the generated documentation.
|
|
39
39
|
*
|
|
40
|
-
* @see https://typedoc.org/
|
|
40
|
+
* @see https://typedoc.org/documents/Options.Input.html#excludeprotected
|
|
41
41
|
*/
|
|
42
42
|
readonly excludeProtected?: boolean;
|
|
43
43
|
/**
|
|
44
44
|
* Prevent symbols that are not exported from being documented.
|
|
45
45
|
*
|
|
46
|
-
* @see https://typedoc.org/
|
|
46
|
+
* @see https://typedoc.org/documents/Options.Input.html#excludeinternal
|
|
47
47
|
*/
|
|
48
48
|
readonly excludeInternal?: boolean;
|
|
49
49
|
/**
|
|
50
50
|
* Specifies the output directory the documentation should be written to.
|
|
51
51
|
*
|
|
52
|
-
* @see https://typedoc.org/
|
|
52
|
+
* @see https://typedoc.org/documents/Options.Output.html#out
|
|
53
53
|
*/
|
|
54
54
|
readonly out?: string;
|
|
55
55
|
/**
|
|
56
56
|
* Specify the location the documentation should be written to.
|
|
57
57
|
*
|
|
58
|
-
* @see https://typedoc.org/
|
|
58
|
+
* @see https://typedoc.org/documents/Options.Output.html#json
|
|
59
59
|
*/
|
|
60
60
|
readonly json?: string;
|
|
61
61
|
/**
|
|
62
62
|
* Specify a theme name to use.
|
|
63
63
|
*
|
|
64
|
-
* @see https://typedoc.org/
|
|
64
|
+
* @see https://typedoc.org/documents/Options.Output.html#theme
|
|
65
65
|
*/
|
|
66
66
|
readonly theme?: string;
|
|
67
67
|
/**
|
|
68
68
|
* Specify the base path for all urls.
|
|
69
69
|
*
|
|
70
|
-
* @see https://typedoc.org/
|
|
70
|
+
* @see https://typedoc.org/documents/Options.Output.html#basepath
|
|
71
71
|
*/
|
|
72
72
|
readonly basePath?: string;
|
|
73
73
|
/**
|
|
74
74
|
* Set the name of the project that will be used in the header of the template.
|
|
75
75
|
*
|
|
76
|
-
* @see https://typedoc.org/
|
|
76
|
+
* @see https://typedoc.org/documents/Options.Output.html#name
|
|
77
77
|
*/
|
|
78
78
|
readonly name?: string;
|
|
79
79
|
/**
|
|
80
80
|
* Prevent TypeDoc from cleaning the output directory specified with --out.
|
|
81
81
|
*
|
|
82
|
-
* @see https://typedoc.org/
|
|
82
|
+
* @see https://typedoc.org/documents/Options.Output.html#cleanoutputdir
|
|
83
83
|
*/
|
|
84
84
|
readonly cleanOutputDir?: boolean;
|
|
85
85
|
/**
|
|
86
86
|
* Specify the location to look for included documents.
|
|
87
87
|
*
|
|
88
|
-
* @see https://typedoc.org/
|
|
88
|
+
* @see https://typedoc.org/documents/Options.Output.html#includes
|
|
89
89
|
*/
|
|
90
90
|
readonly includes?: string;
|
|
91
91
|
/**
|
|
92
92
|
* Specify the location with media files that should be copied to the output directory.
|
|
93
93
|
*
|
|
94
|
-
* @see https://typedoc.org/
|
|
94
|
+
* @see https://typedoc.org/documents/Options.Output.html#media
|
|
95
95
|
*/
|
|
96
96
|
readonly media?: string;
|
|
97
97
|
/**
|
|
98
98
|
* Specify the location and filename a .tsbuildinfo file should be written to.
|
|
99
99
|
*
|
|
100
|
-
* @see https://typedoc.org/
|
|
100
|
+
* @see https://typedoc.org/documents/Options.Input.html#tsbuildinfo
|
|
101
101
|
*/
|
|
102
102
|
readonly tsBuildInfo?: string;
|
|
103
103
|
/**
|
|
104
104
|
* Specify a TypeScript config file that should be used to load TypeScript configuration.
|
|
105
105
|
*
|
|
106
|
-
* @see https://typedoc.org/
|
|
106
|
+
* @see https://typedoc.org/documents/Options.Input.html#tsconfig
|
|
107
107
|
*/
|
|
108
108
|
readonly tsconfig?: string;
|
|
109
109
|
/**
|
|
110
110
|
* Specify the logger that should be used.
|
|
111
111
|
*
|
|
112
|
-
* @see https://typedoc.org/
|
|
112
|
+
* @see https://typedoc.org/documents/Options.Other.html#loglevel
|
|
113
113
|
*/
|
|
114
114
|
readonly logLevel?: LogLevel;
|
|
115
115
|
/**
|
|
116
116
|
* Specify the sort strategy for documented values.
|
|
117
117
|
*
|
|
118
|
-
* @see https://typedoc.org/
|
|
118
|
+
* @see https://typedoc.org/documents/Options.Organization.html#sort
|
|
119
119
|
*/
|
|
120
120
|
readonly sort?: string[];
|
|
121
121
|
/**
|
|
122
122
|
* Specify the sort strategy for static and instance members.
|
|
123
123
|
*
|
|
124
|
-
* @see https://typedoc.org/
|
|
124
|
+
* @see https://typedoc.org/documents/Options.Organization.html#sortentrypoints
|
|
125
125
|
*/
|
|
126
126
|
readonly sortEntryPoints?: boolean;
|
|
127
127
|
/**
|
|
128
128
|
* Specify the documentation mode TypeDoc should use.
|
|
129
129
|
*
|
|
130
|
-
* @see https://typedoc.org/
|
|
130
|
+
* @see https://typedoc.org/documents/Options.Comments.html#commentstyle
|
|
131
131
|
*/
|
|
132
132
|
readonly commentStyle?: CommentStyle;
|
|
133
133
|
/**
|
|
134
134
|
* Specify the default visibility for members without a visibility tag.
|
|
135
135
|
*
|
|
136
|
-
* @see https://typedoc.org/
|
|
136
|
+
* @see https://typedoc.org/documents/Options.Comments.html#defaultvisibility
|
|
137
137
|
*/
|
|
138
138
|
readonly defaultVisibility?: Visibility;
|
|
139
139
|
/**
|
|
140
140
|
* Specify the default category for reflections without a category.
|
|
141
141
|
*
|
|
142
|
-
* @see https://typedoc.org/
|
|
142
|
+
* @see https://typedoc.org/documents/Options.Organization.html#defaultcategory
|
|
143
143
|
*/
|
|
144
144
|
readonly defaultCategory?: string;
|
|
145
145
|
/**
|
|
146
146
|
* Specify the default group for reflections without a group.
|
|
147
147
|
*
|
|
148
|
-
* @see https://typedoc.org/
|
|
148
|
+
* @see https://typedoc.org/documents/Options.Organization.html#defaultgroup
|
|
149
149
|
*/
|
|
150
150
|
readonly defaultGroup?: string;
|
|
151
151
|
/**
|
|
152
152
|
* Specify the categories that will be used to group reflections.
|
|
153
153
|
*
|
|
154
|
-
* @see https://typedoc.org/
|
|
154
|
+
* @see https://typedoc.org/documents/Options.Organization.html#categorizebygroup
|
|
155
155
|
*/
|
|
156
156
|
readonly categorizeByGroup?: boolean;
|
|
157
157
|
/**
|
|
158
158
|
* Specify the search group boosts.
|
|
159
159
|
*
|
|
160
|
-
* @see https://typedoc.org/
|
|
160
|
+
* @see https://typedoc.org/documents/Options.Organization.html#searchgroupboosts
|
|
161
161
|
*/
|
|
162
162
|
readonly searchGroupBoosts?: Record<string, number>;
|
|
163
163
|
/**
|
|
164
164
|
* Specify the search category boosts.
|
|
165
165
|
*
|
|
166
|
-
* @see https://typedoc.org/
|
|
166
|
+
* @see https://typedoc.org/documents/Options.Organization.html#searchcategoryboosts
|
|
167
167
|
*/
|
|
168
168
|
readonly searchCategoryBoosts?: Record<string, number>;
|
|
169
169
|
/**
|
|
170
170
|
* Specify the readme file that should be displayed on the index page.
|
|
171
171
|
*
|
|
172
|
-
* @see https://typedoc.org/
|
|
172
|
+
* @see https://typedoc.org/documents/Options.Input.html#readme
|
|
173
173
|
*/
|
|
174
174
|
readonly readme?: string;
|
|
175
175
|
/**
|
|
176
176
|
* Specify the package.json file that should be used to determine the package name.
|
|
177
177
|
*
|
|
178
|
-
* @see https://typedoc.org/
|
|
178
|
+
* @see https://typedoc.org/documents/Options.Input.html#packagejson
|
|
179
179
|
*/
|
|
180
180
|
readonly packageJson?: string;
|
|
181
181
|
/**
|
|
182
182
|
* Specify the git revision that should be used to link to source files.
|
|
183
183
|
*
|
|
184
|
-
* @see https://typedoc.org/
|
|
184
|
+
* @see https://typedoc.org/documents/Options.Comments.html#gitrevision
|
|
185
185
|
*/
|
|
186
186
|
readonly gitRevision?: string;
|
|
187
187
|
/**
|
|
188
188
|
* Specify the git remote that should be used to link to source files.
|
|
189
189
|
*
|
|
190
|
-
* @see https://typedoc.org/
|
|
190
|
+
* @see https://typedoc.org/documents/Options.Comments.html#gitremote
|
|
191
191
|
*/
|
|
192
192
|
readonly gitRemote?: string;
|
|
193
193
|
/**
|
|
194
|
-
* Specify
|
|
194
|
+
* Specify a link template to be used when generating source urls.
|
|
195
195
|
*
|
|
196
|
-
* @see https://typedoc.org/
|
|
196
|
+
* @see https://typedoc.org/documents/Options.Input.html#sourcelinktemplate
|
|
197
197
|
*/
|
|
198
|
-
readonly
|
|
198
|
+
readonly sourceLinkTemplate?: string;
|
|
199
199
|
/**
|
|
200
|
-
*
|
|
200
|
+
* Disables automatically linking to source code.
|
|
201
201
|
*
|
|
202
|
-
* @see https://typedoc.org/
|
|
202
|
+
* @see https://typedoc.org/documents/Options.Comments.html#disablesources
|
|
203
203
|
*/
|
|
204
204
|
readonly disableSources?: boolean;
|
|
205
205
|
/**
|
|
206
|
-
*
|
|
206
|
+
* Disables setting the source of reflections when documenting projects within a Git repository.
|
|
207
207
|
*
|
|
208
|
-
* @see https://typedoc.org/
|
|
208
|
+
* @see https://typedoc.org/documents/Options.Comments.html#disablegit
|
|
209
209
|
*/
|
|
210
210
|
readonly disableGit?: boolean;
|
|
211
211
|
/**
|
|
212
|
-
*
|
|
212
|
+
* Do not print the TypeDoc link at the end of the page.
|
|
213
213
|
*
|
|
214
|
-
* @see https://typedoc.org/
|
|
214
|
+
* @see https://typedoc.org/documents/Options.Output.html#hidegenerator
|
|
215
215
|
*/
|
|
216
216
|
readonly hideGenerator?: boolean;
|
|
217
217
|
/**
|
|
218
|
-
*
|
|
218
|
+
* Hide parameter types in the signature.
|
|
219
219
|
*
|
|
220
|
-
* @see https://typedoc.org/
|
|
220
|
+
* @see https://typedoc.org/documents/Options.Output.html#hideparametertypesintitle
|
|
221
221
|
*/
|
|
222
222
|
readonly hideParameterTypesInTitle?: boolean;
|
|
223
223
|
/**
|
|
224
|
-
*
|
|
224
|
+
* Include the generation time in links to prevent browsers from using a cached version.
|
|
225
225
|
*
|
|
226
|
-
* @see https://typedoc.org/
|
|
226
|
+
* @see https://typedoc.org/documents/Options.Output.html#cachebust
|
|
227
227
|
*/
|
|
228
228
|
readonly cacheBust?: boolean;
|
|
229
229
|
/**
|
|
230
|
-
*
|
|
230
|
+
* If set, the search index will also include comments.
|
|
231
231
|
*
|
|
232
|
-
* @see https://typedoc.org/
|
|
232
|
+
* @see https://typedoc.org/documents/Options.Output.html#searchincomments
|
|
233
233
|
*/
|
|
234
234
|
readonly searchInComments?: boolean;
|
|
235
235
|
/**
|
|
236
|
-
*
|
|
236
|
+
* If set, the search index will also include documents.
|
|
237
237
|
*
|
|
238
|
-
* @see https://typedoc.org/
|
|
238
|
+
* @see https://typedoc.org/documents/Options.Output.html#searchindocuments
|
|
239
239
|
*/
|
|
240
240
|
readonly searchInDocuments?: boolean;
|
|
241
241
|
/**
|
|
242
|
-
* Specify
|
|
242
|
+
* Specify validation options.
|
|
243
243
|
*
|
|
244
|
-
* @see https://typedoc.org/
|
|
244
|
+
* @see https://typedoc.org/documents/Options.Validation.html
|
|
245
245
|
*/
|
|
246
246
|
readonly validation?: ValidationOptions;
|
|
247
247
|
/**
|
|
248
|
-
* Specify the
|
|
248
|
+
* Specify the type of reflections that must be documented.
|
|
249
249
|
*
|
|
250
|
-
* @see https://typedoc.org/
|
|
250
|
+
* @see https://typedoc.org/documents/Options.Validation.html#requiredtobedocumented
|
|
251
251
|
*/
|
|
252
252
|
readonly requiredToBeDocumented?: string[];
|
|
253
253
|
/**
|
|
254
|
-
*
|
|
254
|
+
* If set, warnings will be treated as errors.
|
|
255
255
|
*
|
|
256
|
-
* @see https://typedoc.org/
|
|
256
|
+
* @see https://typedoc.org/documents/Options.Validation.html#treatwarningsaserrors
|
|
257
257
|
*/
|
|
258
258
|
readonly treatWarningsAsErrors?: boolean;
|
|
259
259
|
/**
|
|
260
|
-
*
|
|
260
|
+
* If set, validation warnings will be treated as errors.
|
|
261
261
|
*
|
|
262
|
-
* @see https://typedoc.org/
|
|
262
|
+
* @see https://typedoc.org/documents/Options.Validation.html#treatvalidationwarningsaserrors
|
|
263
263
|
*/
|
|
264
264
|
readonly treatValidationWarningsAsErrors?: boolean;
|
|
265
265
|
/**
|
|
266
|
-
*
|
|
266
|
+
* A list of types that should not produce warnings when not being exported.
|
|
267
267
|
*
|
|
268
|
-
* @see https://typedoc.org/
|
|
268
|
+
* @see https://typedoc.org/documents/Options.Validation.html#intentionallynotexported
|
|
269
269
|
*/
|
|
270
270
|
readonly intentionallyNotExported?: string[];
|
|
271
271
|
/**
|
|
272
|
-
*
|
|
272
|
+
* Define patterns for files that should be considered external.
|
|
273
273
|
*
|
|
274
|
-
* @see https://typedoc.org/
|
|
274
|
+
* @see https://typedoc.org/documents/Options.Input.html#externalpattern
|
|
275
275
|
*/
|
|
276
276
|
readonly externalPattern?: string[];
|
|
277
277
|
/**
|
|
278
|
-
*
|
|
278
|
+
* Define custom mappings for symbols in external packages.
|
|
279
279
|
*
|
|
280
|
-
* @see https://typedoc.org/
|
|
280
|
+
* @see https://typedoc.org/documents/Options.Comments.html#externalsymbollinkmappings
|
|
281
281
|
*/
|
|
282
282
|
readonly externalSymbolLinkMappings?: Record<string, Record<string, string>>;
|
|
283
283
|
}
|
|
@@ -289,7 +289,7 @@ export declare function toJson_TypeDocConfiguration(obj: TypeDocConfiguration |
|
|
|
289
289
|
/**
|
|
290
290
|
* Specifies the strategy to be used to convert entry points into documentation
|
|
291
291
|
*
|
|
292
|
-
* @see https://typedoc.org/
|
|
292
|
+
* @see https://typedoc.org/documents/Options.Input.html#entrypointstrategy
|
|
293
293
|
*/
|
|
294
294
|
export declare enum EntryPointStrategy {
|
|
295
295
|
/**
|
|
@@ -312,7 +312,7 @@ export declare enum EntryPointStrategy {
|
|
|
312
312
|
/**
|
|
313
313
|
* Specifies the logger that should be used
|
|
314
314
|
*
|
|
315
|
-
* @see https://typedoc.org/
|
|
315
|
+
* @see https://typedoc.org/documents/Options.Other.html#loglevel
|
|
316
316
|
*/
|
|
317
317
|
export declare enum LogLevel {
|
|
318
318
|
VERBOSE = "Verbose",
|
|
@@ -324,7 +324,7 @@ export declare enum LogLevel {
|
|
|
324
324
|
/**
|
|
325
325
|
* Specifies the documentation mode TypeDoc should use
|
|
326
326
|
*
|
|
327
|
-
* @see https://typedoc.org/
|
|
327
|
+
* @see https://typedoc.org/documents/Options.Comments.html#commentstyle
|
|
328
328
|
*/
|
|
329
329
|
export declare enum CommentStyle {
|
|
330
330
|
JSDOC = "jsdoc",
|
|
@@ -335,7 +335,7 @@ export declare enum CommentStyle {
|
|
|
335
335
|
/**
|
|
336
336
|
* Specifies the default visibility for members without a visibility tag
|
|
337
337
|
*
|
|
338
|
-
* @see https://typedoc.org/
|
|
338
|
+
* @see https://typedoc.org/documents/Options.Comments.html#defaultvisibility
|
|
339
339
|
*/
|
|
340
340
|
export declare enum Visibility {
|
|
341
341
|
PUBLIC = "public",
|
|
@@ -345,7 +345,7 @@ export declare enum Visibility {
|
|
|
345
345
|
/**
|
|
346
346
|
* Validation options
|
|
347
347
|
*
|
|
348
|
-
* @see https://typedoc.org/
|
|
348
|
+
* @see https://typedoc.org/documents/Options.Validation.html
|
|
349
349
|
*/
|
|
350
350
|
export interface ValidationOptions {
|
|
351
351
|
/**
|