Skip to content

Commit beac0d9

Browse files
djihdjih
committed
fix identify documentation
1 parent 138f38f commit beac0d9

File tree

6 files changed

+29
-29
lines changed

6 files changed

+29
-29
lines changed

‎documentation/Amplitude.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2343,7 +2343,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Amplitude
23432343
<br class="clear">
23442344

23452345
<footer>
2346-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Tue Apr 05 2016 13:49:39 GMT-0700 (PDT)
2346+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Tue Apr 05 2016 13:53:21 GMT-0700 (PDT)
23472347
</footer>
23482348

23492349
<script> prettyPrint(); </script>

‎documentation/Identify.html

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ <h3 class="subsection-title">Methods</h3>
151151

152152

153153

154-
<h4 class="name" id="add"><span class="type-signature"></span>add<span class="signature">(property, value)</span><span class="type-signature"> &rarr; {Identify_object}</span></h4>
154+
<h4 class="name" id="add"><span class="type-signature"></span>add<span class="signature">(property, value)</span><span class="type-signature"> &rarr; {<a href="Identify.html">Identify</a>}</span></h4>
155155

156156

157157

@@ -316,7 +316,7 @@ <h5>Returns:</h5>
316316
</dt>
317317
<dd>
318318

319-
<span class="param-type">Identify_object</span>
319+
<span class="param-type"><a href="Identify.html">Identify</a></span>
320320

321321

322322
</dd>
@@ -337,7 +337,7 @@ <h5>Example</h5>
337337

338338

339339

340-
<h4 class="name" id="append"><span class="type-signature"></span>append<span class="signature">(property, value)</span><span class="type-signature"> &rarr; {Identify_object}</span></h4>
340+
<h4 class="name" id="append"><span class="type-signature"></span>append<span class="signature">(property, value)</span><span class="type-signature"> &rarr; {<a href="Identify.html">Identify</a>}</span></h4>
341341

342342

343343

@@ -512,7 +512,7 @@ <h5>Returns:</h5>
512512
</dt>
513513
<dd>
514514

515-
<span class="param-type">Identify_object</span>
515+
<span class="param-type"><a href="Identify.html">Identify</a></span>
516516

517517

518518
</dd>
@@ -534,7 +534,7 @@ <h5>Example</h5>
534534

535535

536536

537-
<h4 class="name" id="prepend"><span class="type-signature"></span>prepend<span class="signature">(property, value)</span><span class="type-signature"> &rarr; {Identify_object}</span></h4>
537+
<h4 class="name" id="prepend"><span class="type-signature"></span>prepend<span class="signature">(property, value)</span><span class="type-signature"> &rarr; {<a href="Identify.html">Identify</a>}</span></h4>
538538

539539

540540

@@ -710,7 +710,7 @@ <h5>Returns:</h5>
710710
</dt>
711711
<dd>
712712

713-
<span class="param-type">Identify_object</span>
713+
<span class="param-type"><a href="Identify.html">Identify</a></span>
714714

715715

716716
</dd>
@@ -732,7 +732,7 @@ <h5>Example</h5>
732732

733733

734734

735-
<h4 class="name" id="set"><span class="type-signature"></span>set<span class="signature">(property, value)</span><span class="type-signature"> &rarr; {Identify_object}</span></h4>
735+
<h4 class="name" id="set"><span class="type-signature"></span>set<span class="signature">(property, value)</span><span class="type-signature"> &rarr; {<a href="Identify.html">Identify</a>}</span></h4>
736736

737737

738738

@@ -903,7 +903,7 @@ <h5>Returns:</h5>
903903
</dt>
904904
<dd>
905905

906-
<span class="param-type">Identify_object</span>
906+
<span class="param-type"><a href="Identify.html">Identify</a></span>
907907

908908

909909
</dd>
@@ -925,7 +925,7 @@ <h5>Example</h5>
925925

926926

927927

928-
<h4 class="name" id="setOnce"><span class="type-signature"></span>setOnce<span class="signature">(property, value)</span><span class="type-signature"> &rarr; {Identify_object}</span></h4>
928+
<h4 class="name" id="setOnce"><span class="type-signature"></span>setOnce<span class="signature">(property, value)</span><span class="type-signature"> &rarr; {<a href="Identify.html">Identify</a>}</span></h4>
929929

930930

931931

@@ -1098,7 +1098,7 @@ <h5>Returns:</h5>
10981098
</dt>
10991099
<dd>
11001100

1101-
<span class="param-type">Identify_object</span>
1101+
<span class="param-type"><a href="Identify.html">Identify</a></span>
11021102

11031103

11041104
</dd>
@@ -1119,7 +1119,7 @@ <h5>Example</h5>
11191119

11201120

11211121

1122-
<h4 class="name" id="unset"><span class="type-signature"></span>unset<span class="signature">(property)</span><span class="type-signature"> &rarr; {Identify_object}</span></h4>
1122+
<h4 class="name" id="unset"><span class="type-signature"></span>unset<span class="signature">(property)</span><span class="type-signature"> &rarr; {<a href="Identify.html">Identify</a>}</span></h4>
11231123

11241124

11251125

@@ -1257,7 +1257,7 @@ <h5>Returns:</h5>
12571257
</dt>
12581258
<dd>
12591259

1260-
<span class="param-type">Identify_object</span>
1260+
<span class="param-type"><a href="Identify.html">Identify</a></span>
12611261

12621262

12631263
</dd>
@@ -1295,7 +1295,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Amplitude
12951295
<br class="clear">
12961296

12971297
<footer>
1298-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Tue Apr 05 2016 13:49:40 GMT-0700 (PDT)
1298+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Tue Apr 05 2016 13:53:21 GMT-0700 (PDT)
12991299
</footer>
13001300

13011301
<script> prettyPrint(); </script>

‎documentation/amplitude.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1054,7 +1054,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Amplitude
10541054
<br class="clear">
10551055

10561056
<footer>
1057-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Tue Apr 05 2016 13:49:39 GMT-0700 (PDT)
1057+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Tue Apr 05 2016 13:53:21 GMT-0700 (PDT)
10581058
</footer>
10591059

10601060
<script> prettyPrint(); </script>

‎documentation/identify.js.html

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ <h1 class="page-title">Source: identify.js</h1>
6666
* @public
6767
* @param {string} property - The user property key.
6868
* @param {number|string} value - The amount by which to increment the user property. Allows numbers as strings (ex: '123').
69-
* @return {Identify_object} Returns the same Identify object, allowing you to chain multiple method calls together.
69+
* @return {Identify} Returns the same Identify object, allowing you to chain multiple method calls together.
7070
* @example var identify = new amplitude.Identify().add('karma', 1).add('friends', 1);
7171
* amplitude.identify(identify); // send the Identify call
7272
*/
@@ -89,7 +89,7 @@ <h1 class="page-title">Source: identify.js</h1>
8989
* @param {string} property - The user property key.
9090
* @param {number|string|list|object} value - A value or values to append.
9191
* Values can be numbers, strings, lists, or object (key:value dict will be flattened).
92-
* @return {Identify_object} Returns the same Identify object, allowing you to chain multiple method calls together.
92+
* @return {Identify} Returns the same Identify object, allowing you to chain multiple method calls together.
9393
* @example var identify = new amplitude.Identify().append('ab-tests', 'new-user-tests');
9494
* identify.append('some_list', [1, 2, 3, 4, 'values']);
9595
* amplitude.identify(identify); // send the Identify call
@@ -128,7 +128,7 @@ <h1 class="page-title">Source: identify.js</h1>
128128
* @param {string} property - The user property key.
129129
* @param {number|string|list|object} value - A value or values to prepend.
130130
* Values can be numbers, strings, lists, or object (key:value dict will be flattened).
131-
* @return {Identify_object} Returns the same Identify object, allowing you to chain multiple method calls together.
131+
* @return {Identify} Returns the same Identify object, allowing you to chain multiple method calls together.
132132
* @example var identify = new amplitude.Identify().prepend('ab-tests', 'new-user-tests');
133133
* identify.prepend('some_list', [1, 2, 3, 4, 'values']);
134134
* amplitude.identify(identify); // send the Identify call
@@ -144,7 +144,7 @@ <h1 class="page-title">Source: identify.js</h1>
144144
* @param {string} property - The user property key.
145145
* @param {number|string|list|object} value - A value or values to set.
146146
* Values can be numbers, strings, lists, or object (key:value dict will be flattened).
147-
* @return {Identify_object} Returns the same Identify object, allowing you to chain multiple method calls together.
147+
* @return {Identify} Returns the same Identify object, allowing you to chain multiple method calls together.
148148
* @example var identify = new amplitude.Identify().set('user_type', 'beta');
149149
* identify.set('name', {'first': 'John', 'last': 'Doe'}); // dict is flattened and becomes name.first: John, name.last: Doe
150150
* amplitude.identify(identify); // send the Identify call
@@ -162,7 +162,7 @@ <h1 class="page-title">Source: identify.js</h1>
162162
* @param {string} property - The user property key.
163163
* @param {number|string|list|object} value - A value or values to set once.
164164
* Values can be numbers, strings, lists, or object (key:value dict will be flattened).
165-
* @return {Identify_object} Returns the same Identify object, allowing you to chain multiple method calls together.
165+
* @return {Identify} Returns the same Identify object, allowing you to chain multiple method calls together.
166166
* @example var identify = new amplitude.Identify().setOnce('sign_up_date', '2016-04-01');
167167
* amplitude.identify(identify); // send the Identify call
168168
*/
@@ -175,7 +175,7 @@ <h1 class="page-title">Source: identify.js</h1>
175175
* Unset and remove a user property. This user property will no longer show up in a user's profile.
176176
* @public
177177
* @param {string} property - The user property key.
178-
* @return {Identify_object} Returns the same Identify object, allowing you to chain multiple method calls together.
178+
* @return {Identify} Returns the same Identify object, allowing you to chain multiple method calls together.
179179
* @example var identify = new amplitude.Identify().unset('user_type').unset('age');
180180
* amplitude.identify(identify); // send the Identify call
181181
*/
@@ -226,7 +226,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Amplitude
226226
<br class="clear">
227227

228228
<footer>
229-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Tue Apr 05 2016 13:49:39 GMT-0700 (PDT)
229+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Tue Apr 05 2016 13:53:21 GMT-0700 (PDT)
230230
</footer>
231231

232232
<script> prettyPrint(); </script>

‎documentation/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Amplitude
5656
<br class="clear">
5757

5858
<footer>
59-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Tue Apr 05 2016 13:49:39 GMT-0700 (PDT)
59+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Tue Apr 05 2016 13:53:21 GMT-0700 (PDT)
6060
</footer>
6161

6262
<script> prettyPrint(); </script>

‎src/identify.js

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ var Identify = function() {
3838
* @public
3939
* @param {string} property - The user property key.
4040
* @param {number|string} value - The amount by which to increment the user property. Allows numbers as strings (ex: '123').
41-
* @return {Identify_object} Returns the same Identify object, allowing you to chain multiple method calls together.
41+
* @return {Identify} Returns the same Identify object, allowing you to chain multiple method calls together.
4242
* @example var identify = new amplitude.Identify().add('karma', 1).add('friends', 1);
4343
* amplitude.identify(identify); // send the Identify call
4444
*/
@@ -61,7 +61,7 @@ Identify.prototype.add = function(property, value) {
6161
* @param {string} property - The user property key.
6262
* @param {number|string|list|object} value - A value or values to append.
6363
* Values can be numbers, strings, lists, or object (key:value dict will be flattened).
64-
* @return {Identify_object} Returns the same Identify object, allowing you to chain multiple method calls together.
64+
* @return {Identify} Returns the same Identify object, allowing you to chain multiple method calls together.
6565
* @example var identify = new amplitude.Identify().append('ab-tests', 'new-user-tests');
6666
* identify.append('some_list', [1, 2, 3, 4, 'values']);
6767
* amplitude.identify(identify); // send the Identify call
@@ -100,7 +100,7 @@ Identify.prototype.clearAll = function() {
100100
* @param {string} property - The user property key.
101101
* @param {number|string|list|object} value - A value or values to prepend.
102102
* Values can be numbers, strings, lists, or object (key:value dict will be flattened).
103-
* @return {Identify_object} Returns the same Identify object, allowing you to chain multiple method calls together.
103+
* @return {Identify} Returns the same Identify object, allowing you to chain multiple method calls together.
104104
* @example var identify = new amplitude.Identify().prepend('ab-tests', 'new-user-tests');
105105
* identify.prepend('some_list', [1, 2, 3, 4, 'values']);
106106
* amplitude.identify(identify); // send the Identify call
@@ -116,7 +116,7 @@ Identify.prototype.prepend = function(property, value) {
116116
* @param {string} property - The user property key.
117117
* @param {number|string|list|object} value - A value or values to set.
118118
* Values can be numbers, strings, lists, or object (key:value dict will be flattened).
119-
* @return {Identify_object} Returns the same Identify object, allowing you to chain multiple method calls together.
119+
* @return {Identify} Returns the same Identify object, allowing you to chain multiple method calls together.
120120
* @example var identify = new amplitude.Identify().set('user_type', 'beta');
121121
* identify.set('name', {'first': 'John', 'last': 'Doe'}); // dict is flattened and becomes name.first: John, name.last: Doe
122122
* amplitude.identify(identify); // send the Identify call
@@ -134,7 +134,7 @@ Identify.prototype.set = function(property, value) {
134134
* @param {string} property - The user property key.
135135
* @param {number|string|list|object} value - A value or values to set once.
136136
* Values can be numbers, strings, lists, or object (key:value dict will be flattened).
137-
* @return {Identify_object} Returns the same Identify object, allowing you to chain multiple method calls together.
137+
* @return {Identify} Returns the same Identify object, allowing you to chain multiple method calls together.
138138
* @example var identify = new amplitude.Identify().setOnce('sign_up_date', '2016-04-01');
139139
* amplitude.identify(identify); // send the Identify call
140140
*/
@@ -147,7 +147,7 @@ Identify.prototype.setOnce = function(property, value) {
147147
* Unset and remove a user property. This user property will no longer show up in a user's profile.
148148
* @public
149149
* @param {string} property - The user property key.
150-
* @return {Identify_object} Returns the same Identify object, allowing you to chain multiple method calls together.
150+
* @return {Identify} Returns the same Identify object, allowing you to chain multiple method calls together.
151151
* @example var identify = new amplitude.Identify().unset('user_type').unset('age');
152152
* amplitude.identify(identify); // send the Identify call
153153
*/

0 commit comments

Comments
 (0)