Add inline documentation for evalR methods (#571)

* Add inline docs for evalR methods

* Apply suggestions from code review

---------

Co-authored-by: George Stagg <[email protected]>

Author: AABoyles

src/webR/webr-main.ts

@@ -486,18 +486,42 @@ export class WebR {
     return this.globalShelter.evalR(code, options);
   }
 
+  /**
+   * Evaluate the given R code, returning a promise for no return data.
+   * @param {string} code The R code to evaluate.
+   * @param {EvalROptions} [options] Options for the execution environment.
+   * @returns {Promise<void>} A promise which fires when the R code completes, but returns no data.
+   */
   async evalRVoid(code: string, options?: EvalROptions) {
     return this.evalRRaw(code, 'void', options);
   }
 
+  /**
+   * Evaluate the given R code, returning a promise for a boolean value. If the returned R value is not a boolean, an error will be thrown.
+   * @param {string} code The R code to evaluate.
+   * @param {EvalROptions} [options] Options for the execution environment.
+   * @returns {Promise<boolean>} The result of the computation.
+   */
   async evalRBoolean(code: string, options?: EvalROptions) {
     return this.evalRRaw(code, 'boolean', options);
   }
 
+  /**
+   * Evaluate the given R code, returning a promise for a number. If the returned R value is not a number, an error will be thrown.
+   * @param {string} code The R code to evaluate.
+   * @param {EvalROptions} [options] Options for the execution environment.
+   * @returns {Promise<number>} The result of the computation.
+   */
   async evalRNumber(code: string, options?: EvalROptions) {
     return this.evalRRaw(code, 'number', options);
   }
 
+  /**
+   * Evaluate the given R code, returning a promise for a string. If the returned R value is not a string, an error will be thrown.
+   * @param {string} code The R code to evaluate.
+   * @param {EvalROptions} [options] Options for the execution environment.
+   * @returns {Promise<string>} The result of the computation.
+   */
   async evalRString(code: string, options?: EvalROptions) {
     return this.evalRRaw(code, 'string', options);
   }