Skip to content

Commit

Permalink
docs: update deprecation notices to link to migration doc
Browse files Browse the repository at this point in the history
  • Loading branch information
davidlj95 committed Nov 21, 2024
1 parent 1c94a45 commit 9c0a6dd
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 10 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ import { NgxMetaMetaDefinition } from './ngx-meta-meta-definition'
* ```
*
* @deprecated Use {@link NgxMetaElementsService} APIs instead.
* See {@link https://ngx-meta.dev/guides/manage-your-custom-metadata/ | custom metadata guide} for more info
* See {@link https://ngx-meta.dev/migrations/01-meta-element-apis | migration guide} for more info
*
* @param names - Names to create they key name
* @param options - Options object
Expand All @@ -45,7 +45,7 @@ export const makeComposedKeyValMetaDefinition = (
* Options argument object for {@link makeComposedKeyValMetaDefinition}
*
* @deprecated Use {@link NgxMetaElementsService} APIs instead.
* See {@link https://ngx-meta.dev/guides/manage-your-custom-metadata/ | custom metadata guide} for more info
* See {@link https://ngx-meta.dev/migrations/01-meta-element-apis | migration guide} for more info
*
* @public
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import { NgxMetaMetaDefinition } from './ngx-meta-meta-definition'
* actual value
*
* @deprecated Use {@link NgxMetaElementsService} APIs instead.
* See {@link https://ngx-meta.dev/guides/manage-your-custom-metadata/ | custom metadata guide} for more info
* See {@link https://ngx-meta.dev/migrations/01-meta-element-apis | migration guide} for more info
*
* @param keyName - Name of the key in the key/value meta definition
* @param options - Specifies HTML attribute names and extras of the definition if any
Expand Down Expand Up @@ -52,7 +52,7 @@ export const makeKeyValMetaDefinition = (
* Options argument object for {@link makeKeyValMetaDefinition}
*
* @deprecated Use {@link NgxMetaElementsService} APIs instead.
* See {@link https://ngx-meta.dev/guides/manage-your-custom-metadata/ | custom metadata guide} for more info
* See {@link https://ngx-meta.dev/migrations/01-meta-element-apis | migration guide} for more info
*
* @public
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
* See {@link NgxMetaMetaService.set}
*
* @deprecated Use {@link NgxMetaElementsService} APIs instead.
* See {@link https://ngx-meta.dev/guides/manage-your-custom-metadata/ | custom metadata guide} for more info
* See {@link https://ngx-meta.dev/migrations/01-meta-element-apis | migration guide} for more info
*
* @public
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { MetaDefinition } from '@angular/platform-browser'
* - {@link makeComposedKeyValMetaDefinition}
*
* @deprecated Use {@link NgxMetaElementsService} APIs instead.
* See {@link https://ngx-meta.dev/guides/manage-your-custom-metadata/ | custom metadata guide} for more info
* See {@link https://ngx-meta.dev/migrations/01-meta-element-apis | migration guide} for more info
*
* @remarks
*
Expand All @@ -26,7 +26,7 @@ export interface NgxMetaMetaDefinition {
* With the given content as value of the `<meta>` element.
*
* @deprecated Use {@link NgxMetaElementsService} APIs instead.
* See {@link https://ngx-meta.dev/guides/manage-your-custom-metadata/ | custom metadata guide} for more info
* See {@link https://ngx-meta.dev/migrations/01-meta-element-apis | migration guide} for more info
*
* @example
* For instance, `(content) => ({name: 'description', content})` to create a
Expand All @@ -40,7 +40,7 @@ export interface NgxMetaMetaDefinition {
* to identify the `<meta>` element. In order to remove this specific `<meta>` element when needed.
*
* @deprecated Use {@link NgxMetaElementsService} APIs instead.
* See {@link https://ngx-meta.dev/guides/manage-your-custom-metadata/ | custom metadata guide} for more info
* See {@link https://ngx-meta.dev/migrations/01-meta-element-apis | migration guide} for more info
*
* @example
* For instance, `[name='description']` for the `<meta name='description'>` element.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import { NgxMetaMetaContent } from './ngx-meta-meta-content'
* Uses Angular {@link https://angular.dev/api/platform-browser/Meta | Meta} APIs under the hood.
*
* @deprecated Use {@link NgxMetaElementsService} APIs instead.
* See {@link https://ngx-meta.dev/guides/manage-your-custom-metadata/ | custom metadata guide} for more info
* See {@link https://ngx-meta.dev/migrations/01-meta-element-apis | migration guide} for more info
*
* @public
*/
Expand All @@ -27,7 +27,7 @@ export class NgxMetaMetaService {
* The element is created with the provided content. If no content is given, element is removed.
*
* @deprecated Use {@link NgxMetaElementsService} APIs instead.
* See {@link https://ngx-meta.dev/guides/manage-your-custom-metadata/ | custom metadata guide} for more info
* See {@link https://ngx-meta.dev/migrations/01-meta-element-apis | migration guide} for more info
*
* @param definition - `<meta>` element to create, update or remove
* @param content - Content value to create or update the `<meta>` element.
Expand Down

0 comments on commit 9c0a6dd

Please sign in to comment.