Fixed missing hyphen in param tag

Signed-off-by: Robert Bunning <rbunning@webstaurantstore.com>
This commit is contained in:
Robert Bunning
2022-12-21 12:44:16 -05:00
parent 2a90eb3668
commit 39b54c6dd0
2 changed files with 2 additions and 4 deletions
-2
View File
@@ -22,9 +22,7 @@ export type AdrContentDecorator = (adrInfo: {
// @public
export interface AdrFileFetcher {
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
useGetAdrFilesAtUrl: (url: string) => any;
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
useReadAdrFileAtUrl: (url: string) => any;
}
+2 -2
View File
@@ -50,14 +50,14 @@ export interface AdrFileFetcher {
/**
* A hook to get a listing of adr files that exist at the provided url
*
* @param url The url to get files from
* @param url - The url to get files from
*/
useGetAdrFilesAtUrl: (url: string) => any;
/**
* A hook to get the contents of the adr file at the provided url
*
* @param url The url of the adr file
* @param url - The url of the adr file
*/
useReadAdrFileAtUrl: (url: string) => any;
}