Merge d1a7a82 into 6046a17

coveo · Feb 8, 2017 · 60ee64d · 60ee64d
2 parents 6046a17 + d1a7a82
commit 60ee64d
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 9 deletions.
diff --git a/src/ui/Analytics/Analytics.ts b/src/ui/Analytics/Analytics.ts
@@ -43,7 +43,7 @@ export interface IAnalyticsOptions {
  * See [Step 7 - Usage Analytics](https://developers.coveo.com/x/EYskAg) of the Getting Started with the JavaScript
  * Search Framework V1 tutorial for an introduction to usage analytics.
  *
- * # Send Custom Events
+ * ## Send Custom Events
  * In some scenarios, you might want to send custom data to the Coveo Cloud Usage Analytics (see
  * [Coveo Cloud Usage Analytics](http://www.coveo.com/go?dest=cloudhelp&lcid=9&context=89)). The Coveo JavaScript Search
  * Framework offers helper functions to communicate with the Coveo Usage Analytics REST API, so you do not have to write

diff --git a/src/ui/PipelineContext/PipelineContext.ts b/src/ui/PipelineContext/PipelineContext.ts
@@ -42,7 +42,7 @@ export interface IPipelineContextOptions {
  *
  * Using this component as opposed to JavaScript code means you will be able to leverage the interface editor.
  *
- * Regardless of if you use this component or JavaScript to add context, both will add the needed data in the {@link Query.context} parameter.
+ * Regardless of if you use this component or JavaScript to add context, both will add the needed data in the [Query.Context]{@link IQuery.context} parameter.
  */
 export class PipelineContext extends Component {
   static ID = 'PipelineContext';

diff --git a/src/ui/Quickview/Quickview.ts b/src/ui/Quickview/Quickview.ts
@@ -37,12 +37,15 @@ interface IQuickviewOpenerObject {
  *
  * Most of the time, this component will reference a {@link QuickviewDocument} in its content template.
  *
- * # Choosing what to display for the Quickview
+ * ## Choosing what to display for the Quickview
  * The Quick View uses any HTML structure you put inside its tag and uses that as the content of the dialog box. This content can thus be any element you decide, using your CSS and your structure.
  *
- * > Example
- * > You can change the appearance of the Quick View link by adding HTML inside the body of the div.
- * > You can change the content of the Quick View link by specifying a template ID.
+ * ## Example
+ * - You can change the appearance of the Quick View link by adding HTML inside the body of the div.
+ * 
+ * - You can change the content of the Quick View link by specifying a template ID.
+ * 
+ * - You can use the methods of the [CoreHelpers]{@link ICoreHelpers} in the template.
  *
  * ```html
  * <!-- This would change the appearance of the quickview button itself in the result. -->

diff --git a/src/ui/ResultList/ResultList.ts b/src/ui/ResultList/ResultList.ts
@@ -45,8 +45,8 @@ export interface IResultListOptions {
  * This component is responsible for displaying the results of the current query using one or more result templates.<br/>
  * It supports many additional features such as infinite scrolling.
  *
- * # Examples / samples
- * This contains some quick example. Refer to result templates on developers.coveo.com for more information.
+ * ## Examples / samples
+ * This contains some quick examples. Refer to result templates on [developers.coveo.com](https://developers.coveo.com/display/public/JsSearchV1/JavaScript+Search+Framework+V1+Home) for more information.
  *
  * ```html
  * <!-- A very simple result list with a single underscore template.

diff --git a/test/ui/RevealQuerySuggestAddonTest.ts b/test/ui/RevealQuerySuggestAddonTest.ts
@@ -94,7 +94,7 @@ export function RevealQuerySuggestAddonTest() {
 
       // PhantomJS faulty Promise implementation causes issues here
       if (!Simulate.isPhantomJs()) {
-        describe('with a cache', ()=> {
+        describe('with a cache', () => {
           it('should cache the result', (done) => {
             let revealQuerySuggest = new RevealQuerySuggestAddon(omnibox);
             let firstPromise = new Promise((resolve, reject) => {