railbird/react-native-vision-camera
10
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Use @linkcode for typedocs

Browse Source
This commit is contained in:
Marc Rousavy
2021-03-08 18:51:53 +01:00
parent b93bb2a68b
commit bfba6a95ee
8 changed files with 73 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/hooks/useCameraDevices.ts
View File

@@ -15,10 +15,10 @@ const DefaultCameraDevices: CameraDevices = {
};
/**
* Gets the best available `CameraDevice`. Devices with more cameras are preferred.
* Gets the best available {@linkcode CameraDevice}. Devices with more cameras are preferred.
*
* @returns The best matching `CameraDevice`.
* @throws {@link CameraRuntimeError} if no device was found.
* @returns The best matching {@linkcode CameraDevice}.
* @throws {@linkcode CameraRuntimeError} if no device was found.
* @example
* ```jsx
* const device = useCameraDevice()
@@ -29,11 +29,11 @@ const DefaultCameraDevices: CameraDevices = {
export function useCameraDevices(): CameraDevices;
/**
* Gets a `CameraDevice` for the requested device type.
* Gets a {@linkcode CameraDevice} for the requested device type.
*
* @param {PhysicalCameraDeviceType | LogicalCameraDeviceType} deviceType Specifies a device type which will be used as a device filter.
* @returns A `CameraDevice` for the requested device type.
* @throws {@link CameraRuntimeError} if no device was found.
* @returns A {@linkcode CameraDevice} for the requested device type.
* @throws {@linkcode CameraRuntimeError} if no device was found.
* @example
* ```jsx
* const device = useCameraDevice('wide-angle-camera')