Fix @throws
TypeDocs
This commit is contained in:
parent
b1f78c0807
commit
1f96aaa69f
@ -238,7 +238,7 @@ export class Camera extends React.PureComponent<CameraProps, CameraState> {
|
|||||||
/**
|
/**
|
||||||
* Take a single photo and write it's content to a temporary file.
|
* Take a single photo and write it's content to a temporary file.
|
||||||
*
|
*
|
||||||
* @throws {CameraCaptureError} When any kind of error occured. Use the `CameraCaptureError.code` property to get the actual error
|
* @throws {@link CameraCaptureError} When any kind of error occured. Use the `CameraCaptureError.code` property to get the actual error
|
||||||
*/
|
*/
|
||||||
public async takePhoto(options?: TakePhotoOptions): Promise<PhotoFile> {
|
public async takePhoto(options?: TakePhotoOptions): Promise<PhotoFile> {
|
||||||
try {
|
try {
|
||||||
@ -275,7 +275,7 @@ export class Camera extends React.PureComponent<CameraProps, CameraState> {
|
|||||||
*
|
*
|
||||||
* @blocking This function is synchronized/blocking.
|
* @blocking This function is synchronized/blocking.
|
||||||
*
|
*
|
||||||
* @throws {CameraCaptureError} When any kind of error occured. Use the `CameraCaptureError.code` property to get the actual error
|
* @throws {@link CameraCaptureError} When any kind of error occured. Use the `CameraCaptureError.code` property to get the actual error
|
||||||
*
|
*
|
||||||
* @example
|
* @example
|
||||||
* ```js
|
* ```js
|
||||||
|
@ -18,7 +18,7 @@ const DefaultCameraDevices: CameraDevices = {
|
|||||||
* Gets the best available `CameraDevice`. Devices with more cameras are preferred.
|
* Gets the best available `CameraDevice`. Devices with more cameras are preferred.
|
||||||
*
|
*
|
||||||
* @returns The best matching `CameraDevice`.
|
* @returns The best matching `CameraDevice`.
|
||||||
* @throws `CameraRuntimeError` if no device was found.
|
* @throws {@link CameraRuntimeError} if no device was found.
|
||||||
* @example
|
* @example
|
||||||
* ```jsx
|
* ```jsx
|
||||||
* const device = useCameraDevice()
|
* const device = useCameraDevice()
|
||||||
@ -33,7 +33,7 @@ export function useCameraDevices(): CameraDevices;
|
|||||||
*
|
*
|
||||||
* @param {PhysicalCameraDeviceType | LogicalCameraDeviceType} deviceType Specifies a device type which will be used as a device filter.
|
* @param {PhysicalCameraDeviceType | LogicalCameraDeviceType} deviceType Specifies a device type which will be used as a device filter.
|
||||||
* @returns A `CameraDevice` for the requested device type.
|
* @returns A `CameraDevice` for the requested device type.
|
||||||
* @throws `CameraRuntimeError` if no device was found.
|
* @throws {@link CameraRuntimeError} if no device was found.
|
||||||
* @example
|
* @example
|
||||||
* ```jsx
|
* ```jsx
|
||||||
* const device = useCameraDevice('wide-angle-camera')
|
* const device = useCameraDevice('wide-angle-camera')
|
||||||
|
Loading…
Reference in New Issue
Block a user