From 699179dbc52112ee54c83f3a3f587e38d6f95477 Mon Sep 17 00:00:00 2001
From: chris48s <git@chris-shaw.dev>
Date: Mon, 12 Aug 2024 07:40:53 +0100
Subject: [PATCH] add return descriptions

---
 src/plugins.js | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/src/plugins.js b/src/plugins.js
index 6116200..73ccb11 100644
--- a/src/plugins.js
+++ b/src/plugins.js
@@ -20,7 +20,7 @@ class BasePlugin {
    * document formats that can be parsed. Any formats registered with this hook
    * become valid values for the `parser` property in custom schemas.
    *
-   * @returns {string[]}
+   * @returns {string[]} Document formats to register
    */
   registerDocumentFormats() {
     return [];
@@ -38,7 +38,7 @@ class BasePlugin {
    * @param {string | undefined} format - If this filename matched a document
    *   parser the user has specified in a custom schema, this will be passed to
    *   `parseDocument` in the `format` param.
-   * @returns {object | undefined}
+   * @returns {object | undefined} Parsed file contents
    */
   // eslint-disable-next-line no-unused-vars
   parseDocument(contents, filename, format) {
@@ -51,7 +51,7 @@ class BasePlugin {
    * valid values for the `format` property in the config file and the
    * `--format` command line argument.
    *
-   * @returns {string[]}
+   * @returns {string[]} Output formats to register
    */
   registerOutputFormats() {
     return [];
@@ -73,7 +73,7 @@ class BasePlugin {
    * @param {string} filename - The document filename.
    * @param {string} format - The user's requested output format as specified in
    *   the config file or via the `--format` command line argument.
-   * @returns {string | undefined}
+   * @returns {string | undefined} Log message
    */
   // eslint-disable-next-line no-unused-vars
   getSingleResultLogMessage(result, filename, format) {
@@ -99,7 +99,7 @@ class BasePlugin {
    *   filename to [ValidationResult](#ValidationResult) object.
    * @param {string} format - The user's requested output format as specified in
    *   the config file or via the `--format` command line argument.
-   * @returns {string | undefined}
+   * @returns {string | undefined} Log message
    */
   // eslint-disable-next-line no-unused-vars
   getAllResultsLogMessage(results, format) {