fix: bad jsdoc comments

serialport · Jan 31, 2022 · 1a84827 · 1a84827
1 parent 31b09e0
commit 1a84827
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 881 deletions.
diff --git a/lib/index.ts b/lib/index.ts
@@ -76,9 +76,10 @@ export interface BindingPortInterface {
 
     The in progress reads must error when the port is closed with an error object that has the property `canceled` equal to `true`. Any other error will cause a disconnection.
 
-   * @param offset The offset in the buffer to start writing at.
-   * @param length Specifies the maximum number of bytes to read.
-   * @returns {Promise} Resolves with the number of bytes read after a read operation.
+   * @param buffer - The Buffer to read data into.
+   * @param offset - The offset in the buffer to start writing at.
+   * @param length - Specifies the maximum number of bytes to read.
+   * @returns Promise - Resolves with the number of bytes read after a read operation.
    */
   read(buffer: Buffer, offset: number, length: number): Promise<{ buffer: Buffer; bytesRead: number }>