chore doc update

Author: farfromrefug

src/bottom-navigation/index.d.ts

@@ -54,7 +54,8 @@ export class BottomNavigation extends TabNavigationBase {
      */
     public static selectedIndexChangedEvent: string;
 
-    /**
+    /** 
+     * @hidden
      * A basic method signature to hook an event listener (shortcut alias to the addEventListener method).
      * @param eventNames - String corresponding to events (e.g. "propertyChange"). Optionally could be used more events separated by `,` (e.g. "propertyChange", "change").
      * @param callback - Callback function which will be executed when event is raised.

src/bottomsheet/bottomsheet.d.ts

@@ -5,26 +5,68 @@ export { BottomSheetOptions };
 
 export declare abstract class ViewWithBottomSheetBase extends View {
     // used when triggering the closing of the bottomsheet
-    protected _closeBottomSheetCallback: Function;
+    /**
+     * @hidden
+     */
+     protected _closeBottomSheetCallback: Function;
     // used when the bottomSheet is dismissed
-    public _onDismissBottomSheetCallback: Function;
-    _bottomSheetFragment: any; // com.google.android.material.bottomsheet.BottomSheetDialogFragment
-    protected abstract _hideNativeBottomSheet(parent: any, whenClosedCallback: any): void;
-    protected _bottomSheetContext: any;
+    /**
+     * @hidden
+     */
+     public _onDismissBottomSheetCallback: Function;
+    /**
+     * @hidden
+     */
+     _bottomSheetFragment: any; // com.google.android.material.bottomsheet.BottomSheetDialogFragment
+    /**
+     * @hidden
+     */
+     protected abstract _hideNativeBottomSheet(parent: any, whenClosedCallback: any): void;
+    /**
+     * @hidden
+     */
+     protected _bottomSheetContext: any;
+    /**
+     * @hidden
+     */
     _raiseShownBottomSheetEvent(): void;
     public _bottomSheetClosed(): void;
+    /**
+     * @hidden
+     */
     protected abstract _showNativeBottomSheet(parent: View, options: BottomSheetOptions): void;
-    protected _commonShowNativeBottomSheet(parent: View, options: BottomSheetOptions): void;
+    /**
+     * @hidden
+     */
+     protected _commonShowNativeBottomSheet(parent: View, options: BottomSheetOptions): void;
+    
+    /**
+     * @hidden
+     */
     protected _raiseShowingBottomSheetEvent(): void;
+
+
+    /**
+     * closes the current BottomSheet
+     *
+     * @param args anything you want as a result of the `showBottomSheet` Promise
+     */
     public closeBottomSheet(...args: any): void;
 
-    public showBottomSheet(options: BottomSheetOptions): ViewBase;
+
+    /**
+     *  shows a modal BottomSheet
+     *
+     * @param {BottomSheetOptions} options
+     * @returns {View} view - the view shown in the BottomSheet
+     */
+    public showBottomSheet(options: BottomSheetOptions): View;
 }
 export function install(): void;
 
 declare module '@nativescript/core/ui/core/view' {
     interface View {
         closeBottomSheet(...args: any): void;
-        showBottomSheet(options: BottomSheetOptions): ViewBase;
+        showBottomSheet(options: BottomSheetOptions): View;
     }
 }

src/core/index.d.ts

@@ -2,8 +2,8 @@ import { Color, LengthPercentUnit, PercentLength } from '@nativescript/core';
 
 declare module '@nativescript/core/ui/core/view' {
     interface View {
-        clearFocus();
-        requestFocus();
+        clearFocus():void;
+        requestFocus():void;
     }
 }
 

src/core/tab-navigation-base/tab-navigation-base/index.d.ts

@@ -56,7 +56,8 @@ export class TabNavigationBase extends View {
      */
     public static selectedIndexChangedEvent: string;
 
-    /**
+    /** 
+     * @hidden
      * A basic method signature to hook an event listener (shortcut alias to the addEventListener method).
      * @param eventNames - String corresponding to events (e.g. "propertyChange"). Optionally could be used more events separated by `,` (e.g. "propertyChange", "change").
      * @param callback - Callback function which will be executed when event is raised.

src/core/tab-navigation-base/tab-strip-item/index.d.ts

@@ -52,7 +52,8 @@ export class TabStripItem extends View {
     static unselectEvent: string;
     //@endprivate
 
-    /**
+    /** 
+	 * @hidden
 	 * A basic method signature to hook an event listener (shortcut alias to the addEventListener method).
 	 * @param eventNames - String corresponding to events (e.g. "propertyChange"). Optionally could be used more events separated by `,` (e.g. "propertyChange", "change").
 	 * @param callback - Callback function which will be executed when event is raised.

src/core/tab-navigation-base/tab-strip/index.d.ts

@@ -50,7 +50,8 @@ export class TabStrip extends View {
      */
     public static itemTapEvent: string;
 
-    /**
+    /** 
+     * @hidden
      * A basic method signature to hook an event listener (shortcut alias to the addEventListener method).
      * @param eventNames - String corresponding to events (e.g. "propertyChange"). Optionally could be used more events separated by `,` (e.g. "propertyChange", "change").
      * @param callback - Callback function which will be executed when event is raised.

tsconfig.doc.json

@@ -5,6 +5,6 @@
         "sourceMap": false,
         "plugins": []
     },
-    "include":["packages/**/*.d.ts"],
-    "exclude": ["**/*android*", "**/*ios*"]
+    "include": ["src/**/*.d.ts"],
+    "exclude": ["**/*android*", "**/*ios*", "**/typings/*"]
 }

typedoc.js

@@ -1,12 +1,12 @@
 module.exports = {
-    mode: 'modules',
+    // mode: 'modules',
     out: 'docs',
-    exclude: ['**/node_modules/**', '**/*.spec.ts'],
+    exclude: ['**/node_modules/**', '**/*.spec.ts', '*typings*'],
     name: 'Nativescript UI Material Components',
-    excludePrivate: true,
-    ignoreCompilerErrors: true,
-    excludeNotExported: true,
-    includeDeclarations: true,
+    // excludePrivate: true,
+    // ignoreCompilerErrors: true,
+    // excludeNotExported: true,
+    // includeDeclarations: true,
     excludePrivate: true,
     excludeExternals: true,
     tsconfig: 'tsconfig.doc.json',