Skip to content

Commit a9bd499

Browse files
committed
chore: doc update
1 parent 86b849a commit a9bd499

File tree

46 files changed

+234
-9
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+234
-9
lines changed

builddoc.mjs

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import typedocJson from './typedoc.js';
1111
* @param {string} options.outDir
1212
* @param {Partial<import('typedoc').TypeDocOptions>} [typeDocOptions]
1313
*/
14-
export async function createTypeScriptApiDocs ({ entryPoint, outDir }, typeDocOptions) {
14+
export async function createTypeScriptApiDocs ({ outDir }, typeDocOptions = {}) {
1515
const app = new td.Application();
1616
app.options.addReader(new td.TSConfigReader());
1717
console.log('createTypeScriptApiDocs', typeDocOptions);
@@ -21,26 +21,34 @@ export async function createTypeScriptApiDocs ({ entryPoint, outDir }, typeDocOp
2121
});
2222
console.log('files', files);
2323
app.bootstrap({
24-
tsconfig: 'tsconfig.json',
24+
logger: "console",
25+
disableSources: true,
26+
cleanOutputDir: true,
27+
tsconfig: 'tsconfig.doc.json',
28+
entryPointStrategy: td.EntryPointStrategy.Expand,
29+
entryPoints: files,
2530
...typedocJson,
26-
...typeDocOptions,
27-
entryPoints: files
31+
...typeDocOptions
2832
});
2933
//@ts-ignore
3034
app.options.setCompilerOptions(files, {
3135
esModuleInterop: true
3236
});
33-
const program = ts.createProgram(app.options.getFileNames(), app.options.getCompilerOptions());
37+
// const program = ts.createProgram(app.options.getFileNames(), app.options.getCompilerOptions());
3438

35-
const project = app.converter.convert(app.expandInputFiles(app.options.getValue('entryPoints')), program);
39+
const project = app.converter.convert(app.getEntryPoints() ?? []);
3640

3741
if (project) {
3842
await app.generateDocs(project, outDir);
3943
} else {
40-
throw new Error(`Error creating the TypeScript API docs for ${entryPoint}.`);
44+
throw new Error(`Error creating the typedoc project`);
4145
}
4246
};
4347
// app.generateDocs(project, "./docs");
4448
// app.generateJson(project, "./docs.json");
4549

46-
createTypeScriptApiDocs({ outDir: './docs' });
50+
try {
51+
await createTypeScriptApiDocs({ outDir: './docs' });
52+
} catch(err) {
53+
console.error(err);
54+
}

docs/.nojekyll

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ActivityIndicator | Nativescript UI Material Components</title><meta name="description" content="Documentation for Nativescript UI Material Components"/><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 async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">Nativescript UI Material Components</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></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">Nativescript UI Material Components</a></li><li><a href="../modules/_nativescript_community_ui_material_activityindicator.html">@nativescript-community/ui-material-activityindicator</a></li><li><a href="_nativescript_community_ui_material_activityindicator.ActivityIndicator.html">ActivityIndicator</a></li></ul><h1>Class ActivityIndicator</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">any</span><ul class="tsd-hierarchy"><li><span class="target">ActivityIndicator</span></li></ul></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 tsd-is-inherited"><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="_nativescript_community_ui_material_activityindicator.ActivityIndicator.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">new <wbr/>Activity<wbr/>Indicator<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_nativescript_community_ui_material_activityindicator.ActivityIndicator.html" class="tsd-signature-type" data-tsd-kind="Class">ActivityIndicator</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from mixin(ActivityIndicatorBase, NSProgress).constructor</p></aside><h4 class="tsd-returns-title">Returns <a href="_nativescript_community_ui_material_activityindicator.ActivityIndicator.html" class="tsd-signature-type" data-tsd-kind="Class">ActivityIndicator</a></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">Modules</a></li><li class="current tsd-kind-module"><a href="../modules/_nativescript_community_ui_material_activityindicator.html">@nativescript-<wbr/>community/ui-<wbr/>material-<wbr/>activityindicator</a></li><li class=" tsd-kind-module"><a href="../modules/_nativescript_community_ui_material_bottom_navigation.html">@nativescript-<wbr/>community/ui-<wbr/>material-<wbr/>bottom-<wbr/>navigation</a></li><li class=" tsd-kind-module"><a href="../modules/_nativescript_community_ui_material_bottomnavigationbar.html">@nativescript-<wbr/>community/ui-<wbr/>material-<wbr/>bottomnavigationbar</a></li><li class=" tsd-kind-module"><a href="../modules/_nativescript_community_ui_material_bottomsheet.html">@nativescript-<wbr/>community/ui-<wbr/>material-<wbr/>bottomsheet</a></li><li class=" tsd-kind-module"><a href="../modules/_nativescript_community_ui_material_button.html">@nativescript-<wbr/>community/ui-<wbr/>material-<wbr/>button</a></li><li class=" tsd-kind-module"><a href="../modules/_nativescript_community_ui_material_cardview.html">@nativescript-<wbr/>community/ui-<wbr/>material-<wbr/>cardview</a></li><li class=" tsd-kind-module"><a href="../modules/_nativescript_community_ui_material_core.html">@nativescript-<wbr/>community/ui-<wbr/>material-<wbr/>core</a></li><li class=" tsd-kind-module"><a href="../modules/_nativescript_community_ui_material_core_tab_navigation_base_tab_strip.html">@nativescript-<wbr/>community/ui-<wbr/>material-<wbr/>core/tab-<wbr/>navigation-<wbr/>base/tab-<wbr/>strip</a></li><li class=" tsd-kind-module"><a href="../modules/_nativescript_community_ui_material_core_tab_navigation_base_tab_strip_item.html">@nativescript-<wbr/>community/ui-<wbr/>material-<wbr/>core/tab-<wbr/>navigation-<wbr/>base/tab-<wbr/>strip-<wbr/>item</a></li><li class=" tsd-kind-module"><a href="../modules/_nativescript_community_ui_material_dialogs.html">@nativescript-<wbr/>community/ui-<wbr/>material-<wbr/>dialogs</a></li><li class=" tsd-kind-module"><a href="../modules/_nativescript_community_ui_material_floatingactionbutton.html">@nativescript-<wbr/>community/ui-<wbr/>material-<wbr/>floatingactionbutton</a></li><li class=" tsd-kind-module"><a href="../modules/_nativescript_community_ui_material_progress.html">@nativescript-<wbr/>community/ui-<wbr/>material-<wbr/>progress</a></li><li class=" tsd-kind-module"><a href="../modules/_nativescript_community_ui_material_ripple.html">@nativescript-<wbr/>community/ui-<wbr/>material-<wbr/>ripple</a></li><li class=" tsd-kind-module"><a href="../modules/_nativescript_community_ui_material_slider.html">@nativescript-<wbr/>community/ui-<wbr/>material-<wbr/>slider</a></li><li class=" tsd-kind-module"><a href="../modules/_nativescript_community_ui_material_snackbar.html">@nativescript-<wbr/>community/ui-<wbr/>material-<wbr/>snackbar</a></li><li class=" tsd-kind-module"><a href="../modules/_nativescript_community_ui_material_speedial.html">@nativescript-<wbr/>community/ui-<wbr/>material-<wbr/>speedial</a></li><li class=" tsd-kind-module"><a href="../modules/_nativescript_community_ui_material_tabs.html">@nativescript-<wbr/>community/ui-<wbr/>material-<wbr/>tabs</a></li><li class=" tsd-kind-module"><a href="../modules/_nativescript_community_ui_material_textfield.html">@nativescript-<wbr/>community/ui-<wbr/>material-<wbr/>textfield</a></li><li class=" tsd-kind-module"><a href="../modules/_nativescript_community_ui_material_textview.html">@nativescript-<wbr/>community/ui-<wbr/>material-<wbr/>textview</a></li><li class=" tsd-kind-module"><a href="../modules/core_tab_navigation_base_tab_content_item.html">core/tab-<wbr/>navigation-<wbr/>base/tab-<wbr/>content-<wbr/>item</a></li><li class=" tsd-kind-module"><a href="../modules/core_tab_navigation_base_tab_navigation_base.html">core/tab-<wbr/>navigation-<wbr/>base/tab-<wbr/>navigation-<wbr/>base</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class tsd-parent-kind-module"><a href="_nativescript_community_ui_material_activityindicator.ActivityIndicator.html" class="tsd-kind-icon">Activity<wbr/>Indicator</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="_nativescript_community_ui_material_activityindicator.ActivityIndicator.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></li></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-variable"><span class="tsd-kind-icon">Variable</span></li><li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li><li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></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/main.js"></script></body></html>

0 commit comments

Comments
 (0)