Update docs for logger (#1103)

Update docs for logger

Author: TheIronDev

src/logger/index.ts

@@ -8,6 +8,7 @@ import {
 
 /**
  * `LogSeverity` indicates the detailed severity of the log entry. See [LogSeverity](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry#logseverity).
+ * @public
  */
 export type LogSeverity =
   | 'DEBUG'
@@ -23,6 +24,7 @@ export type LogSeverity =
  * `LogEntry` represents a [structured Cloud Logging](https://cloud.google.com/logging/docs/structured-logging)
  * entry. All keys aside from `severity` and `message` are
  * included in the `jsonPayload` of the logged entry.
+ * @public
  */
 export interface LogEntry {
   severity: LogSeverity;
@@ -62,7 +64,8 @@ function removeCircular(obj: any, refs: any[] = []): any {
 
 /**
  * Writes a `LogEntry` to `stdout`/`stderr` (depending on severity).
- * @param entry The `LogEntry` including severity, message, and any additional structured metadata.
+ * @param entry - The `LogEntry` including severity, message, and any additional structured metadata.
+ * @public
  */
 export function write(entry: LogEntry) {
   if (SUPPORTS_STRUCTURED_LOGS) {
@@ -94,7 +97,8 @@ export function write(entry: LogEntry) {
 /**
  * Writes a `DEBUG` severity log. If the last argument provided is a plain object,
  * it is added to the `jsonPayload` in the Cloud Logging entry.
- * @param args Arguments, concatenated into the log message with space separators.
+ * @param args - Arguments, concatenated into the log message with space separators.
+ * @public
  */
 export function debug(...args: any[]) {
   write(entryFromArgs('DEBUG', args));
@@ -103,7 +107,8 @@ export function debug(...args: any[]) {
 /**
  * Writes an `INFO` severity log. If the last argument provided is a plain object,
  * it is added to the `jsonPayload` in the Cloud Logging entry.
- * @param args Arguments, concatenated into the log message with space separators.
+ * @param args - Arguments, concatenated into the log message with space separators.
+ * @public
  */
 export function log(...args: any[]) {
   write(entryFromArgs('INFO', args));
@@ -112,7 +117,8 @@ export function log(...args: any[]) {
 /**
  * Writes an `INFO` severity log. If the last argument provided is a plain object,
  * it is added to the `jsonPayload` in the Cloud Logging entry.
- * @param args Arguments, concatenated into the log message with space separators.
+ * @param args - Arguments, concatenated into the log message with space separators.
+ * @public
  */
 export function info(...args: any[]) {
   write(entryFromArgs('INFO', args));
@@ -121,7 +127,8 @@ export function info(...args: any[]) {
 /**
  * Writes a `WARNING` severity log. If the last argument provided is a plain object,
  * it is added to the `jsonPayload` in the Cloud Logging entry.
- * @param args Arguments, concatenated into the log message with space separators.
+ * @param args - Arguments, concatenated into the log message with space separators.
+ * @public
  */
 export function warn(...args: any[]) {
   write(entryFromArgs('WARNING', args));
@@ -130,7 +137,8 @@ export function warn(...args: any[]) {
 /**
  * Writes an `ERROR` severity log. If the last argument provided is a plain object,
  * it is added to the `jsonPayload` in the Cloud Logging entry.
- * @param args Arguments, concatenated into the log message with space separators.
+ * @param args - Arguments, concatenated into the log message with space separators.
+ * @public
  */
 export function error(...args: any[]) {
   write(entryFromArgs('ERROR', args));