Skip to content

Commit 522392c

Browse files
committed
docs: update TypeDoc configuration and enhance documentation for Hooks and Android features
1 parent 885deaa commit 522392c

5 files changed

Lines changed: 16 additions & 12 deletions

File tree

src/core/classes/Iterable.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -490,7 +490,7 @@ export class Iterable {
490490
/**
491491
* Launch the application from the background in Android devices.
492492
*
493-
* Android only.
493+
* @group Android only.
494494
*
495495
* @example
496496
* ```typescript

src/core/classes/IterableConfig.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -291,6 +291,8 @@ export class IterableConfig {
291291
/**
292292
* Android only feature: This controls whether the SDK should enforce encryption for all PII stored on disk.
293293
* By default, the SDK will not enforce encryption and may fallback to unencrypted storage in case the encryption fails.
294+
*
295+
* @group Android only.
294296
*/
295297
encryptionEnforced = false;
296298

src/core/hooks/useAppStateListener.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ import { AppState } from 'react-native';
77
*
88
* @returns The current app state.
99
*
10+
* @category Hooks
11+
* @group Hooks
12+
*
1013
* @example
1114
* ```typescript
1215
* const appState = useAppStateListener();

src/core/hooks/useDeviceOrientation.tsx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@ export interface IterableDeviceOrientation {
2222
*
2323
* @returns {IterableDeviceOrientation} An object containing the height, width, and a boolean `isPortrait` indicating if the device is in portrait mode.
2424
*
25+
* @category Hooks
26+
* @group Hooks
27+
*
2528
* @example
2629
* const { height, width, isPortrait } = useDeviceOrientation();
2730
*

typedoc.config.mjs

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,9 @@ const config = {
4545
document: false,
4646
},
4747
groupOrder: [
48-
'Guides',
48+
'Documents',
4949
'React Components',
50+
'Hooks',
5051
'Classes',
5152
'Enums',
5253
'Interfaces',
@@ -56,7 +57,7 @@ const config = {
5657
'Constants',
5758
'*',
5859
],
59-
categoryOrder: ['Guides', 'React Components', '*'],
60+
categoryOrder: ['React Components', 'Hooks', '*'],
6061
// jsDocCompatibility: {
6162
// inheritDocTag: true,
6263
// },
@@ -111,11 +112,13 @@ const config = {
111112
},
112113
searchCategoryBoosts: {
113114
'React Components': 1.5,
114-
'Guides': 1.5,
115+
'Hooks': 1.5,
115116
},
116117
searchGroupBoosts: {
117118
'React Components': 1.5,
118-
'Guides': 1.5,
119+
'Hooks': 1.5,
120+
'Documents': 1.5,
121+
'Classes': 1.3,
119122
},
120123
visibilityFilters: {
121124
'protected': false,
@@ -168,14 +171,7 @@ const config = {
168171
plugin: [
169172
'typedoc-plugin-coverage',
170173
'typedoc-plugin-mermaid',
171-
// 'typedoc-plugin-inline-sources',
172-
// 'typedoc-plugin-dt-links',
173-
// 'typedoc-plugin-localization',
174-
// 'typedoc-plugin-emojify',
175-
// '@reside-ic/typedoc-plugin-copy-doc',
176174
'typedoc-github-theme',
177-
// 'typedoc-material-theme',
178-
// '@droppedcode/typedoc-plugin-relative-includes',
179175
],
180176
};
181177

0 commit comments

Comments
 (0)