Skip to content

Commit b66e158

Browse files
authored
fix: update links for TSDoc (#1194)
* fix: update links for TSDoc * chore: fix log.write links
1 parent 84d877f commit b66e158

File tree

5 files changed

+40
-37
lines changed

5 files changed

+40
-37
lines changed

src/entry.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -95,12 +95,12 @@ export interface ToJsonOptions {
9595
/**
9696
* Create an entry object to define new data to insert into a meta.
9797
*
98-
* Note, [Cloud Logging Quotas and limits]{@link https://cloud.google.com/logging/quotas}
98+
* Note, {@link https://cloud.google.com/logging/quotas|Cloud Logging Quotas and limits}
9999
* dictates that the maximum log entry size, including all
100100
* [LogEntry Resource properties]{@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry},
101-
* cannot exceed _approximately_ 256 KB.
101+
* cannot exceed approximately 256 KB.
102102
*
103-
* @see [LogEntry JSON representation]{@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry}
103+
* See {@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry|LogEntry JSON representation}
104104
*
105105
* @class
106106
*

src/index.ts

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -228,8 +228,11 @@ export interface ServiceContext {
228228
* @class
229229
*
230230
* See {@link https://cloud.google.com/logging/docs| What is Cloud Logging?}
231+
*
231232
* See {@link https://cloud.google.com/logging/docs/api| Introduction to the Cloud Logging API}
233+
*
232234
* See {@link https://www.npmjs.com/package/@google-cloud/logging-bunyan| Logging to Google Cloud from Bunyan}
235+
*
233236
* See {@link https://www.npmjs.com/package/@google-cloud/logging-winston| Logging to Google Cloud from Winston}
234237
*
235238
* @param {ClientConfig} [options] Configuration options.
@@ -336,9 +339,9 @@ class Logging {
336339
/**
337340
* Create a sink.
338341
*
339-
* @see [Sink Overview]{@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.sinks}
340-
* @see [Advanced Logs Filters]{@link https://cloud.google.com/logging/docs/view/advanced_filters}
341-
* @see [projects.sinks.create API Documentation]{@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.sinks/create}
342+
* See {@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.sinks|Sink Overview}
343+
* See {@link https://cloud.google.com/logging/docs/view/advanced_filters|Advanced Logs Filters}
344+
* See {@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.sinks/create|projects.sinks.create API Documentation}
342345
*
343346
* @param {string} name Name of the sink.
344347
* @param {CreateSinkRequest} config Config to set for the sink.
@@ -424,12 +427,12 @@ class Logging {
424427
* the object returned in other API calls, such as
425428
* {@link Log#write}.
426429
*
427-
* Note, [Cloud Logging Quotas and limits]{@link https://cloud.google.com/logging/quotas}
430+
* Note, {@link https://cloud.google.com/logging/quotas|Cloud Logging Quotas and limits}
428431
* dictates that the maximum log entry size, including all
429432
* [LogEntry Resource properties]{@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry},
430433
* cannot exceed _approximately_ 256 KB.
431434
*
432-
* @see [LogEntry JSON representation]{@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry}
435+
* See {@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry|LogEntry JSON representation}
433436
*
434437
* @param {?object|?string} [resource] See a
435438
* [Monitored
@@ -513,7 +516,7 @@ class Logging {
513516
/**
514517
* List the entries in your logs.
515518
*
516-
* @see [entries.list API Documentation]{@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/entries/list}
519+
* See {@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/entries/list|entries.list API Documentation}
517520
*
518521
* @param {GetEntriesRequest} [query] Query object for listing entries.
519522
* @param {GetEntriesCallback} [callback] Callback function.
@@ -872,7 +875,7 @@ class Logging {
872875
/**
873876
* List the entries in your logs.
874877
*
875-
* @see [logs.list API Documentation]{@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/logs/list}
878+
* See {@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/logs/list|logs.list API Documentation}
876879
*
877880
* @param {GetLogsRequest} [query] Query object for listing entries.
878881
* @param {GetLogsCallback} [callback] Callback function.
@@ -1061,7 +1064,7 @@ class Logging {
10611064
/**
10621065
* Get the sinks associated with this project.
10631066
*
1064-
* @see [projects.sinks.list API Documentation]{@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.sinks/list}
1067+
* See {@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.sinks/list|projects.sinks.list API Documentation}
10651068
*
10661069
* @param {GetSinksRequest} [query] Query object for listing sinks.
10671070
* @param {GetSinksCallback} [callback] Callback function.
@@ -1224,7 +1227,7 @@ class Logging {
12241227
/**
12251228
* Get a reference to a Cloud Logging log.
12261229
*
1227-
* @see [Log Overview]{@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.logs}
1230+
* See {@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.logs|Log Overview}
12281231
*
12291232
* @param {string} name Name of the existing log.
12301233
* @param {object} [options] Configuration object.
@@ -1270,7 +1273,7 @@ class Logging {
12701273
/**
12711274
* Get a reference to a Cloud Logging sink.
12721275
*
1273-
* @see [Sink Overview]{@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.sinks}
1276+
* See {@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.sinks|Sink Overview}
12741277
*
12751278
* @param {string} name Name of the existing sink.
12761279
* @returns {Sink}

src/log-sync.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ import {
4040
* Recommended for Serverless environment logging, especially where async log
4141
* calls made by the `Log` class can be dropped by the CPU.
4242
*
43-
* @see [Structured Logging]{@link https://cloud.google.com/logging/docs/structured-logging}
43+
* See {@link https://cloud.google.com/logging/docs/structured-logging|Structured Logging}
4444
*
4545
* @class
4646
*
@@ -193,7 +193,7 @@ class LogSync implements LogSeverityFunctions {
193193
*
194194
* Using this method will not itself do any logging.
195195
*
196-
* @see [LogEntry JSON representation]{@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry}
196+
* See {@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry|LogEntry JSON representation}
197197
*
198198
* @param {?object} metadata See a
199199
* [LogEntry

src/log.ts

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ export type DeleteCallback = ApiResponseCallback;
7676
* produced by the Apache Web Server, but the log
7777
* `compute.googleapis.com/activity_log` is produced by Google Compute Engine.
7878
*
79-
* @see [Introduction to Logs]{@link https://cloud.google.com/logging/docs/basic-concepts#logs}
79+
* See {@link https://cloud.google.com/logging/docs/basic-concepts#logs|Introduction to Logs}
8080
*
8181
* @class
8282
*
@@ -117,7 +117,7 @@ class Log implements LogSeverityFunctions {
117117
/**
118118
* Write a log entry with a severity of "ALERT".
119119
*
120-
* This is a simple wrapper around {@link Log#write}. All arguments are
120+
* This is a simple wrapper around {@link Log.write|Log.write}. All arguments are
121121
* the same as documented there.
122122
*
123123
* @param {Entry|Entry[]} entry A log entry, or array of entries, to write.
@@ -164,7 +164,7 @@ class Log implements LogSeverityFunctions {
164164
/**
165165
* Write a log entry with a severity of "CRITICAL".
166166
*
167-
* This is a simple wrapper around {@link Log#write}. All arguments are
167+
* This is a simple wrapper around {@link Log.write|Log.write}. All arguments are
168168
* the same as documented there.
169169
*
170170
* @param {Entry|Entry[]} entry A log entry, or array of entries, to write.
@@ -214,7 +214,7 @@ class Log implements LogSeverityFunctions {
214214
/**
215215
* Write a log entry with a severity of "DEBUG".
216216
*
217-
* This is a simple wrapper around {@link Log#write}. All arguments are
217+
* This is a simple wrapper around {@link Log.write|Log.write}. All arguments are
218218
* the same as documented there.
219219
*
220220
* @param {Entry|Entry[]} entry A log entry, or array of entries, to write.
@@ -270,7 +270,7 @@ class Log implements LogSeverityFunctions {
270270
/**
271271
* Delete the log.
272272
*
273-
* @see [projects.logs.delete API Documentation]{@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.logs/delete}
273+
* See {@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.logs/delete|projects.logs.delete API Documentation}
274274
*
275275
* @param {object} [gaxOptions] Request configuration options, outlined
276276
* here: https://googleapis.github.io/gax-nodejs/global.html#CallOptions.
@@ -321,7 +321,7 @@ class Log implements LogSeverityFunctions {
321321
/**
322322
* Write a log entry with a severity of "EMERGENCY".
323323
*
324-
* This is a simple wrapper around {@link Log#write}. All arguments are
324+
* This is a simple wrapper around {@link Log.write|Log.write}. All arguments are
325325
* the same as documented there.
326326
*
327327
* @param {Entry|Entry[]} entry A log entry, or array of entries, to write.
@@ -371,12 +371,12 @@ class Log implements LogSeverityFunctions {
371371
* the object returned in other API calls, such as
372372
* {@link Log#write}.
373373
*
374-
* Note, [Cloud Logging Quotas and limits]{@link https://cloud.google.com/logging/quotas}
374+
* Note, {@link https://cloud.google.com/logging/quotas|Cloud Logging Quotas and limits}
375375
* dictates that the maximum log entry size, including all
376376
* [LogEntry Resource properties]{@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry},
377377
* cannot exceed _approximately_ 256 KB.
378378
*
379-
* @see [LogEntry JSON representation]{@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry}
379+
* See {@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry|LogEntry JSON representation}
380380
*
381381
* @param {?object} metadata See a
382382
* [LogEntry
@@ -444,7 +444,7 @@ class Log implements LogSeverityFunctions {
444444
/**
445445
* Write a log entry with a severity of "ERROR".
446446
*
447-
* This is a simple wrapper around {@link Log#write}. All arguments are
447+
* This is a simple wrapper around {@link Log.write|Log.write}. All arguments are
448448
* the same as documented there.
449449
*
450450
* @param {Entry|Entry[]} entry A log entry, or array of entries, to write.
@@ -492,7 +492,7 @@ class Log implements LogSeverityFunctions {
492492
* This method is a wrapper around {module:logging#getEntries}, but with a
493493
* filter specified to only return entries from this log.
494494
*
495-
* @see [entries.list API Documentation]{@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/entries/list}
495+
* See {@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/entries/list|entries.list API Documentation}
496496
*
497497
* @param {GetEntriesRequest} [query] Query object for listing entries.
498498
* @param {GetEntriesCallback} [callback] Callback function.
@@ -644,7 +644,7 @@ class Log implements LogSeverityFunctions {
644644
/**
645645
* Write a log entry with a severity of "INFO".
646646
*
647-
* This is a simple wrapper around {@link Log#write}. All arguments are
647+
* This is a simple wrapper around {@link Log.write|Log.write}. All arguments are
648648
* the same as documented there.
649649
*
650650
* @param {Entry|Entry[]} entry A log entry, or array of entries, to write.
@@ -691,7 +691,7 @@ class Log implements LogSeverityFunctions {
691691
/**
692692
* Write a log entry with a severity of "NOTICE".
693693
*
694-
* This is a simple wrapper around {@link Log#write}. All arguments are
694+
* This is a simple wrapper around {@link Log.write|Log.write}. All arguments are
695695
* the same as documented there.
696696
*
697697
* @param {Entry|Entry[]} entry A log entry, or array of entries, to write.
@@ -738,7 +738,7 @@ class Log implements LogSeverityFunctions {
738738
/**
739739
* Write a log entry with a severity of "WARNING".
740740
*
741-
* This is a simple wrapper around {@link Log#write}. All arguments are
741+
* This is a simple wrapper around {@link Log.write|Log.write}. All arguments are
742742
* the same as documented there.
743743
*
744744
* @param {Entry|Entry[]} entry A log entry, or array of entries, to write.
@@ -809,12 +809,12 @@ class Log implements LogSeverityFunctions {
809809
/**
810810
* Write log entries to Cloud Logging.
811811
*
812-
* Note, [Cloud Logging Quotas and limits]{@link https://cloud.google.com/logging/quotas}
812+
* Note, {@link https://cloud.google.com/logging/quotas|Cloud Logging Quotas and limits}
813813
* dictates that the maximum cumulative size of all entries per write,
814814
* including all [LogEntry Resource properties]{@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry},
815815
* cannot exceed _approximately_ 10 MB.
816816
*
817-
* @see [entries.write API Documentation]{@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/entries/write}
817+
* See {@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/entries/write|entries.write API Documentation}
818818
*
819819
* @param {Entry|Entry[]} entry A log entry, or array of entries, to write.
820820
* @param {?WriteOptions} [options] Write options

src/sink.ts

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ export interface SetSinkMetadata extends LogSink {
4646
* storage), Google BigQuery datasets (for log analysis), Google Pub/Sub (for
4747
* streaming to other applications).
4848
*
49-
* @see [Introduction to Sinks]{@link https://cloud.google.com/logging/docs/basic-concepts#sinks}
49+
* See {@link https://cloud.google.com/logging/docs/basic-concepts#sinks|Introduction to Sinks}
5050
*
5151
* @class
5252
*
@@ -133,7 +133,7 @@ class Sink {
133133
/**
134134
* Delete the sink.
135135
*
136-
* @see [projects.sink.delete API Documentation]{@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.sinks/delete}
136+
* See {@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.sinks/delete|projects.sink.delete API Documentation}
137137
*
138138
* @param {object} [gaxOptions] Request configuration options, outlined
139139
* here: https://googleapis.github.io/gax-nodejs/global.html#CallOptions.
@@ -195,8 +195,8 @@ class Sink {
195195
/**
196196
* Get the sink's metadata.
197197
*
198-
* @see [Sink Resource]{@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.sinks#LogSink}
199-
* @see [projects.sink.get API Documentation]{@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.sinks/get}
198+
* See {@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.sinks#LogSink|Sink Resource}
199+
* See {@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.sinks/get|projects.sink.get API Documentation}
200200
*
201201
* @param {object} [gaxOptions] Request configuration options, outlined
202202
* here: https://googleapis.github.io/gax-nodejs/global.html#CallOptions.
@@ -256,7 +256,7 @@ class Sink {
256256
*
257257
* This will override any filter that was previously set.
258258
*
259-
* @see [Advanced Logs Filters]{@link https://cloud.google.com/logging/docs/view/advanced_filters}
259+
* See {@link https://cloud.google.com/logging/docs/view/advanced_filters|Advanced Logs Filters}
260260
*
261261
* @param {string} filter The new filter.
262262
* @param {SetSinkFilterCallback} [callback] Callback function.
@@ -305,8 +305,8 @@ class Sink {
305305
* uniqueWriterIdentity = true. Read more about using a unique writer identity
306306
* here: https://cloud.google.com/logging/docs/api/tasks/exporting-logs#using_a_unique_writer_identity
307307
*
308-
* @see [Sink Resource]{@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.sinks#LogSink}
309-
* @see [projects.sink.update API Documentation]{@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.sinks/update}
308+
* See {@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.sinks#LogSink|Sink Resource}
309+
* See {@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.sinks/update|projects.sink.update API Documentation}
310310
*
311311
* @param {object} metadata See a
312312
* [Sink

0 commit comments

Comments
 (0)