Issue #84: Add docs to Logger

Update/fix docs for LogId/RawLogChannel.

Author: mreuvers

core/src/typescript/main/core/api/LogId.ts

@@ -1 +1,4 @@
+/**
+ * Identifier used by a Logger.
+ */
 export type LogId = string;

core/src/typescript/main/core/api/Logger.ts

@@ -25,27 +25,83 @@ export interface Logger {
    */
   readonly runtimeSettings: LogRuntime;
 
+  /**
+   * Log a message on trace, for details please see {@link debug}.
+   */
   trace(message: LogMessageType, ...args: unknown[]): void;
 
+  /**
+   * Log a message on info, for details please see {@link debug}.
+   */
   trace(message: LogMessageType, error: ExceptionType, ...args: unknown[]): void;
 
+  /**
+   * Log a message on debug. Followed by an optional Error, and optional arguments.
+   * @example
+   * ```
+   * log.debug("Hello");
+   * log.debug(() => "Hello");
+   * log.debug(() => "Hello", new Error("SomeError"));
+   * log.debug("Hello", "Some", "Random", "Arguments", [], 123);
+   * log.debug("Hello", new Error("AnotherError"), "Some", "Random", "Arguments", [], 123);
+   * ```
+   * @param message Message
+   * @param args Optional arguments (note the first argument can be a (caught) Error which is treated as such then)
+   */
   debug(message: LogMessageType, ...args: unknown[]): void;
 
+  /**
+   * Log a message on debug. Followed by an optional Error, and optional arguments.
+   * @example
+   * ```
+   * log.debug("Hello");
+   * log.debug(() => "Hello");
+   * log.debug(() => "Hello", new Error("SomeError"));
+   * log.debug("Hello", "Some", "Random", "Arguments", [], 123);
+   * log.debug("Hello", new Error("AnotherError"), "Some", "Random", "Arguments", [], 123);
+   * ```
+   * @param message Message
+   * @param args Optional arguments (note the first argument can be a (caught) Error which is treated as such then)
+   */
   debug(message: LogMessageType, error: ExceptionType, ...args: unknown[]): void;
 
+  /**
+   * Log a message on info, for details please see {@link debug}.
+   */
   info(message: LogMessageType, ...args: unknown[]): void;
 
+  /**
+   * Log a message on info, for details please see {@link debug}.
+   */
   info(message: LogMessageType, error: ExceptionType, ...args: unknown[]): void;
 
+  /**
+   * Log a message on warn, for details please see {@link debug}.
+   */
   warn(message: LogMessageType, ...args: unknown[]): void;
 
+  /**
+   * Log a message on warn, for details please see {@link debug}.
+   */
   warn(message: LogMessageType, error: ExceptionType, ...args: unknown[]): void;
 
+  /**
+   * Log a message on error, for details please see {@link debug}.
+   */
   error(message: LogMessageType, ...args: unknown[]): void;
 
+  /**
+   * Log a message on error, for details please see {@link debug}.
+   */
   error(message: LogMessageType, error: ExceptionType, ...args: unknown[]): void;
 
+  /**
+   * Log a message on fatal, for details please see {@link debug}.
+   */
   fatal(message: LogMessageType, ...args: unknown[]): void;
 
+  /**
+   * Log a message on fatal, for details please see {@link debug}.
+   */
   fatal(message: LogMessageType, error: ExceptionType, ...args: unknown[]): void;
 }

core/src/typescript/main/core/api/RawLogChannel.ts

@@ -8,8 +8,8 @@ export interface RawLogChannel {
   readonly type: "RawLogChannel";
 
   /**
-   * Write the LogMessage or RawLogMessage away. The formatArg function can be used to format
-   * arguments from the LogMessage if needed. By default the formatArg function will
+   * Write the RawLogMessage away. The formatArg function can be used to format
+   * arguments from the RawLogMessage if needed. By default the formatArg function will
    * use JSON.stringify(..), unless a global format function was registered
    * in which case it uses that.
    */