From 852a73ef82561252431648c019637d6f01ff5cfc Mon Sep 17 00:00:00 2001 From: Pete Bacon Darwin Date: Thu, 20 Sep 2018 14:51:54 +0100 Subject: [PATCH] docs(platform-browser): move examples to `@usageNotes` (#26039) PR Close #26039 --- packages/platform-browser/src/dom/debug/by.ts | 9 +++++--- .../platform-browser/testing/src/matchers.ts | 21 ++++++++++++------- 2 files changed, 20 insertions(+), 10 deletions(-) diff --git a/packages/platform-browser/src/dom/debug/by.ts b/packages/platform-browser/src/dom/debug/by.ts index 866885c44a..49e71742c1 100644 --- a/packages/platform-browser/src/dom/debug/by.ts +++ b/packages/platform-browser/src/dom/debug/by.ts @@ -20,7 +20,8 @@ export class By { /** * Match all elements. * - * ## Example + * @usageNotes + * ### Example * * {@example platform-browser/dom/debug/ts/by/by.ts region='by_all'} */ @@ -29,7 +30,8 @@ export class By { /** * Match elements by the given CSS selector. * - * ## Example + * @usageNotes + * ### Example * * {@example platform-browser/dom/debug/ts/by/by.ts region='by_css'} */ @@ -44,7 +46,8 @@ export class By { /** * Match elements that have the given directive present. * - * ## Example + * @usageNotes + * ### Example * * {@example platform-browser/dom/debug/ts/by/by.ts region='by_directive'} */ diff --git a/packages/platform-browser/testing/src/matchers.ts b/packages/platform-browser/testing/src/matchers.ts index 40ea6593f1..65158ffa22 100644 --- a/packages/platform-browser/testing/src/matchers.ts +++ b/packages/platform-browser/testing/src/matchers.ts @@ -20,7 +20,8 @@ export interface NgMatchers extends jasmine.Matchers { /** * Expect the value to be a `Promise`. * - * ## Example + * @usageNotes + * ### Example * * {@example testing/ts/matchers.ts region='toBePromise'} */ @@ -29,7 +30,8 @@ export interface NgMatchers extends jasmine.Matchers { /** * Expect the value to be an instance of a class. * - * ## Example + * @usageNotes + * ### Example * * {@example testing/ts/matchers.ts region='toBeAnInstanceOf'} */ @@ -38,7 +40,8 @@ export interface NgMatchers extends jasmine.Matchers { /** * Expect the element to have exactly the given text. * - * ## Example + * @usageNotes + * ### Example * * {@example testing/ts/matchers.ts region='toHaveText'} */ @@ -47,7 +50,8 @@ export interface NgMatchers extends jasmine.Matchers { /** * Expect the element to have the given CSS class. * - * ## Example + * @usageNotes + * ### Example * * {@example testing/ts/matchers.ts region='toHaveCssClass'} */ @@ -56,7 +60,8 @@ export interface NgMatchers extends jasmine.Matchers { /** * Expect the element to have the given CSS styles. * - * ## Example + * @usageNotes + * ### Example * * {@example testing/ts/matchers.ts region='toHaveCssStyle'} */ @@ -65,7 +70,8 @@ export interface NgMatchers extends jasmine.Matchers { /** * Expect a class to implement the interface of the given class. * - * ## Example + * @usageNotes + * ### Example * * {@example testing/ts/matchers.ts region='toImplement'} */ @@ -74,7 +80,8 @@ export interface NgMatchers extends jasmine.Matchers { /** * Expect an exception to contain the given error text. * - * ## Example + * @usageNotes + * ### Example * * {@example testing/ts/matchers.ts region='toContainError'} */