Skip to content

Commit

Permalink
docs: Make links out of @see tags (#50098)
Browse files Browse the repository at this point in the history
This commit is part of the work for #50097 to improve the linking on the online documentation.

PR Close #50098
  • Loading branch information
JeanMeche authored and pkozlowski-opensource committed May 2, 2023
1 parent c9d4a69 commit 8080bf0
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 20 deletions.
6 changes: 3 additions & 3 deletions packages/common/http/src/jsonp.ts
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,8 @@ export function jsonpCallbackContext(): Object {
/**
* Processes an `HttpRequest` with the JSONP method,
* by performing JSONP style requests.
* @see `HttpHandler`
* @see `HttpXhrBackend`
* @see {@link HttpHandler}
* @see {@link HttpXhrBackend}
*
* @publicApi
*/
Expand Down Expand Up @@ -262,7 +262,7 @@ export function jsonpInterceptorFn(
* Identifies requests with the method JSONP and
* shifts them to the `JsonpClientBackend`.
*
* @see `HttpInterceptor`
* @see {@link HttpInterceptor}
*
* @publicApi
*/
Expand Down
30 changes: 15 additions & 15 deletions packages/common/http/src/provider.ts
Original file line number Diff line number Diff line change
Expand Up @@ -55,12 +55,12 @@ function makeHttpFeature<KindT extends HttpFeatureKind>(
* feature functions to `provideHttpClient`. For example, HTTP interceptors can be added using the
* `withInterceptors(...)` feature.
*
* @see withInterceptors
* @see withInterceptorsFromDi
* @see withXsrfConfiguration
* @see withNoXsrfProtection
* @see withJsonpSupport
* @see withRequestsMadeViaParent
* @see {@link withInterceptors}
* @see {@link withInterceptorsFromDi}
* @see {@link withXsrfConfiguration}
* @see {@link withNoXsrfProtection}
* @see {@link withJsonpSupport}
* @see {@link withRequestsMadeViaParent}
*/
export function provideHttpClient(...features: HttpFeature<HttpFeatureKind>[]):
EnvironmentProviders {
Expand Down Expand Up @@ -101,8 +101,8 @@ export function provideHttpClient(...features: HttpFeature<HttpFeatureKind>[]):
* Adds one or more functional-style HTTP interceptors to the configuration of the `HttpClient`
* instance.
*
* @see HttpInterceptorFn
* @see provideHttpClient
* @see {@link HttpInterceptorFn}
* @see {@link provideHttpClient}
* @publicApi
*/
export function withInterceptors(interceptorFns: HttpInterceptorFn[]):
Expand All @@ -125,9 +125,9 @@ const LEGACY_INTERCEPTOR_FN = new InjectionToken<HttpInterceptorFn>('LEGACY_INTE
* Prefer `withInterceptors` and functional interceptors instead, as support for DI-provided
* interceptors may be phased out in a later release.
*
* @see HttpInterceptor
* @see HTTP_INTERCEPTORS
* @see provideHttpClient
* @see {@link HttpInterceptor}
* @see {@link HTTP_INTERCEPTORS}
* @see {@link provideHttpClient}
*/
export function withInterceptorsFromDi(): HttpFeature<HttpFeatureKind.LegacyInterceptors> {
// Note: the legacy interceptor function is provided here via an intermediate token
Expand All @@ -153,7 +153,7 @@ export function withInterceptorsFromDi(): HttpFeature<HttpFeatureKind.LegacyInte
*
* This feature is incompatible with the `withNoXsrfProtection` feature.
*
* @see provideHttpClient
* @see {@link provideHttpClient}
*/
export function withXsrfConfiguration(
{cookieName, headerName}: {cookieName?: string, headerName?: string}):
Expand All @@ -174,7 +174,7 @@ export function withXsrfConfiguration(
*
* This feature is incompatible with the `withXsrfConfiguration` feature.
*
* @see provideHttpClient
* @see {@link provideHttpClient}
*/
export function withNoXsrfProtection(): HttpFeature<HttpFeatureKind.NoXsrfProtection> {
return makeHttpFeature(HttpFeatureKind.NoXsrfProtection, [
Expand All @@ -188,7 +188,7 @@ export function withNoXsrfProtection(): HttpFeature<HttpFeatureKind.NoXsrfProtec
/**
* Add JSONP support to the configuration of the current `HttpClient` instance.
*
* @see provideHttpClient
* @see {@link provideHttpClient}
*/
export function withJsonpSupport(): HttpFeature<HttpFeatureKind.JsonpSupport> {
return makeHttpFeature(HttpFeatureKind.JsonpSupport, [
Expand All @@ -215,7 +215,7 @@ export function withJsonpSupport(): HttpFeature<HttpFeatureKind.JsonpSupport> {
* "bubble up" until either reaching the root level or an `HttpClient` which was not configured with
* this option.
*
* @see provideHttpClient
* @see {@link provideHttpClient}
* @developerPreview
*/
export function withRequestsMadeViaParent(): HttpFeature<HttpFeatureKind.RequestsMadeViaParent> {
Expand Down
4 changes: 2 additions & 2 deletions packages/common/http/src/xhr.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ function getResponseUrl(xhr: any): string|null {

/**
* Uses `XMLHttpRequest` to send requests to a backend server.
* @see `HttpHandler`
* @see `JsonpClientBackend`
* @see {@link HttpHandler}
* @see {@link JsonpClientBackend}
*
* @publicApi
*/
Expand Down

0 comments on commit 8080bf0

Please sign in to comment.