| #
f6311d0d |
| 12-Jan-2023 |
Bartosz Kaszubowski <[email protected]> |
[docs] APISection: fix comment example in tables, remove legacy code (#20805)
|
| #
5990cc31 |
| 10-Jan-2023 |
Bartosz Kaszubowski <[email protected]> |
[tools][docs] TypeDoc update and related changes (#20687)
|
| #
c8c9d6e8 |
| 21-Sep-2021 |
Bartosz Kaszubowski <[email protected]> |
[tools][docs] bump TypeDoc, migrate to @example annotation (#14465)
|
| #
abded2bb |
| 13-Aug-2021 |
Bartosz Kaszubowski <[email protected]> |
[sqlite] add doc comments in source, update types (#13976)
* [sqlite] add doc comments in source, update types
* correct two types, support unions of array values + test
* remove debug log
[sqlite] add doc comments in source, update types (#13976)
* [sqlite] add doc comments in source, update types
* correct two types, support unions of array values + test
* remove debug log
* Update packages/expo-sqlite/src/SQLite.ts
Co-authored-by: Tomasz Sapeta <[email protected]>
* regenerate data after review
* Update docs/components/plugins/api/APISectionInterfaces.tsx
Co-authored-by: Bartłomiej Bukowski <[email protected]>
* update map file
* fix lint after review updates
Co-authored-by: Tomasz Sapeta <[email protected]>
Co-authored-by: Bartłomiej Bukowski <[email protected]>
show more ...
|
| #
f52aa21e |
| 22-Jul-2021 |
Bartosz Kaszubowski <[email protected]> |
[checkbox] add doc comments in source (#13715)
|
| #
f128dd42 |
| 20-Jul-2021 |
Bartosz Kaszubowski <[email protected]> |
[font] Add doc comments in source (#13650)
|
| #
1ef472c3 |
| 15-Jul-2021 |
Bartosz Kaszubowski <[email protected]> |
[docs] add "Components" section to the generated docs, migrate `AppleAuthenticationButton` (#13567)
Co-authored-by: Bartłomiej Bukowski <[email protected]>
|
| #
d87a784e |
| 06-Jul-2021 |
Bartosz Kaszubowski <[email protected]> |
[docs] improve `resolveTypeName` function, simplify union types, add tests (#13451)
Co-authored-by: Bartłomiej Bukowski <[email protected]>
# Why
Refs ENG-1458
API data documen
[docs] improve `resolveTypeName` function, simplify union types, add tests (#13451)
Co-authored-by: Bartłomiej Bukowski <[email protected]>
# Why
Refs ENG-1458
API data documentation generation feature is still in development and in this PR I'm aiming to improve and simplify types resolution helper util method `resolveTypeName`. Also the changeset includes few new test cases which I have stumble upon working on the `MediaLibrary` package conversion.
# How
Short summary of most important changes:
* types in Unions are now resolved by `resolveTypeName` util
* initial generics and tuple types support
* markup simplification (`span` wrapper removed where possible)
* few fixes for linkable/non-linkable custom types, especially in arrays and unions
* fixes for the few missing `key` warnings for React nodes
# Test Plan
Docs website has been run and tested on `localhost`, all the docs tests and lint checks are successful.
# Disclaimer
I had to introduce small logic change (flip the order of branches) because I have spotted some new issues when working on `MediaLibrary`, additionally I have ported the Tuple type support addition to this PR. This change is also required for `MediaLibrary` docs.
<img width="494" alt="Screenshot 2021-07-02 at 12 24 48" src="https://user-images.githubusercontent.com/719641/124261349-f62d2900-db30-11eb-8964-ca8e52370fae.png">
show more ...
|
| #
6062847e |
| 25-Jun-2021 |
Bartosz Kaszubowski <[email protected]> |
[docs] improvement and fixes for the APISection component (#13337)
[docs] further API data types simplification
# Why & How
Requires merge of #13189
This PR focuses on the improvements and
[docs] improvement and fixes for the APISection component (#13337)
[docs] further API data types simplification
# Why & How
Requires merge of #13189
This PR focuses on the improvements and fixes for the docs `APISection` component or related code:
* `resolveTypeName` method supports now query types and nested unions in `Promise`s and `Record`s
* few custom type render method has been replaced with `resolveTypeName` and there were small changes toward increased generalisation of the code
* for example `decorateValue` from types section has been removed and code rewritten to support `resolveTypeName` approach in there
* API data types has been simplified, types were written at the beginning of project, and with time I'm getting the better understanding fo underlying TypeDoc structure
* `Types` section will not be duplicated on the pages with `Props` section (seen currently on the `BlurView` page
# Test Plan
The changes have been tested by running docs website on `localhost`.
In addition to that, there are two new test cases for `resolveTypeName` render test, which are based on the new supported types added to this method.
show more ...
|
| #
ffc1cfa8 |
| 25-Jun-2021 |
Bartosz Kaszubowski <[email protected]> |
[app-loading] add doc comments in source (#13396)
# Why
To utilize the auto generation feature for API section the package source code must contain the relevant documentation.
Refs #12239
R
[app-loading] add doc comments in source (#13396)
# Why
To utilize the auto generation feature for API section the package source code must contain the relevant documentation.
Refs #12239
Requires #13337 (fix for the duplicate `Types` section for components)
Fixes ENG-1412
# How
This PR moves the current documentation of `AppLoading` component API - https://docs.expo.io/versions/latest/sdk/app-loading - (with minor tweaks and addition) to the package source code.
The changeset also includes move of props to separate type file and an export of component `Props` as `AppLoadingProps` (similar to the `BlurView` and `LinearGradient` components).
There were also small changes to the `APISection` component:
* add ability to extract props data from Class Component (in the similar way which `defaultProps` were extracted before)
* more generic support for deprecation notes (display no longer matter on the entry kind)
* deduplicate component props if props type is set to `union`
* addition of `Error` type to non-linkable types list, new test for `resolveTypeName` with non-linkable type
* small simplification of the `PropsData` type and structure
# Test Plan
The changes and generated content have been tests running docs website on `localhost`.
# Preview
<img width="1507" alt="Screenshot 2021-06-24 at 17 46 30" src="https://user-images.githubusercontent.com/719641/123293406-3f1f2500-d514-11eb-90ea-1a496bc7335f.png">
show more ...
|
| #
c6a02be9 |
| 16-Jun-2021 |
Bartosz Kaszubowski <[email protected]> |
[speech] add doc comments in source (#13257)
|