Sfoglia il codice sorgente

chore(api): fix documentation tags

Lucas Nogueira 3 anni fa
parent
commit
508e815247

+ 2 - 2
tooling/api/src/bundle.ts

@@ -2,8 +2,6 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-License-Identifier: MIT
 
-/** @ignore */ /** */
-
 import 'regenerator-runtime/runtime'
 import * as app from './app'
 import * as cli from './cli'
@@ -21,6 +19,8 @@ import * as tauri from './tauri'
 import * as updater from './updater'
 import * as window from './window'
 import * as os from './os'
+
+/** @ignore */
 const invoke = tauri.invoke
 
 export {

+ 0 - 2
tooling/api/src/helpers/event.ts

@@ -2,8 +2,6 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-License-Identifier: MIT
 
-/** @ignore */
-
 import { WindowLabel } from '../window'
 import { invokeTauriCommand } from './tauri'
 

+ 1 - 1
tooling/api/src/http.ts

@@ -322,7 +322,7 @@ async function getClient(options?: ClientOptions): Promise<Client> {
   }).then((id) => new Client(id))
 }
 
-/** @ignore */
+/** @internal */
 let defaultClient: Client | null = null
 
 /**

+ 1 - 1
tooling/api/src/index.ts

@@ -10,7 +10,7 @@
  * ```typescript
  * import { app, dialog, event, fs, globalShortcut } from '@tauri-apps/api'
  * ```
- * @packageDocumentation
+ * @module
  */
 
 export * from './bundle'