Skip to content

Commit 0e7e535

Browse files
committed
reformat docs
1 parent ee8ebde commit 0e7e535

File tree

7 files changed

+62
-21
lines changed

7 files changed

+62
-21
lines changed

Makefile

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,6 @@ $(OUT): node_modules $(SRC) version
6666
@$(JSHINT) --verbose $(SRC)
6767
@$(DUO) --standalone amplitude src/index.js > $(OUT)
6868
@$(MINIFY) $(OUT) --output $(MIN_OUT)
69-
@$(JSDOC) -d ./documentation/ src/*.js
7069

7170
#
7271
# Target for minified `amplitude-snippet.js` file.
@@ -88,6 +87,9 @@ build: $(TESTS) $(OUT) $(SNIPPET_OUT) $(SEGMENT_SNIPPET_OUT) README.md
8887
@$(DUO) --development test/tests.js > build/tests.js
8988
@$(DUO) --development test/snippet-tests.js > build/snippet-tests.js
9089

90+
docs:
91+
@$(JSDOC) -d ./documentation/ src/*.js
92+
9193
#
9294
# Target for release.
9395
#

documentation/Amplitude.html

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

23222322
<footer>
2323-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Fri Apr 01 2016 16:04:25 GMT-0700 (PDT)
2323+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Fri Apr 01 2016 16:45:14 GMT-0700 (PDT)
23242324
</footer>
23252325

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

documentation/Identify.html

Lines changed: 45 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,10 @@ <h5>Parameters:</h5>
223223
<td class="type">
224224

225225

226-
<span class="param-type">number/string</span>
226+
<span class="param-type">number</span>
227+
|
228+
229+
<span class="param-type">string</span>
227230

228231

229232

@@ -407,7 +410,16 @@ <h5>Parameters:</h5>
407410
<td class="type">
408411

409412

410-
<span class="param-type">number/string/list/object</span>
413+
<span class="param-type">number</span>
414+
|
415+
416+
<span class="param-type">string</span>
417+
|
418+
419+
<span class="param-type">list</span>
420+
|
421+
422+
<span class="param-type">object</span>
411423

412424

413425

@@ -592,7 +604,16 @@ <h5>Parameters:</h5>
592604
<td class="type">
593605

594606

595-
<span class="param-type">number/string/list/object</span>
607+
<span class="param-type">number</span>
608+
|
609+
610+
<span class="param-type">string</span>
611+
|
612+
613+
<span class="param-type">list</span>
614+
|
615+
616+
<span class="param-type">object</span>
596617

597618

598619

@@ -775,7 +796,16 @@ <h5>Parameters:</h5>
775796
<td class="type">
776797

777798

778-
<span class="param-type">number/string/list/object</span>
799+
<span class="param-type">number</span>
800+
|
801+
802+
<span class="param-type">string</span>
803+
|
804+
805+
<span class="param-type">list</span>
806+
|
807+
808+
<span class="param-type">object</span>
779809

780810

781811

@@ -959,7 +989,16 @@ <h5>Parameters:</h5>
959989
<td class="type">
960990

961991

962-
<span class="param-type">number/string/list/object</span>
992+
<span class="param-type">number</span>
993+
|
994+
995+
<span class="param-type">string</span>
996+
|
997+
998+
<span class="param-type">list</span>
999+
|
1000+
1001+
<span class="param-type">object</span>
9631002

9641003

9651004

@@ -1245,7 +1284,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Amplitude
12451284
<br class="clear">
12461285

12471286
<footer>
1248-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Fri Apr 01 2016 16:04:25 GMT-0700 (PDT)
1287+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Fri Apr 01 2016 16:45:14 GMT-0700 (PDT)
12491288
</footer>
12501289

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

documentation/amplitude.js.html

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

10431043
<footer>
1044-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Fri Apr 01 2016 16:04:25 GMT-0700 (PDT)
1044+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Fri Apr 01 2016 16:45:14 GMT-0700 (PDT)
10451045
</footer>
10461046

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

documentation/identify.js.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ <h1 class="page-title">Source: identify.js</h1>
6464
* Increment a user property by a given value (can also be negative to decrement). If the user property does not have a value set yet, it will be initialized to 0 before being incremented.
6565
* @public
6666
* @param {string} property - The user property key.
67-
* @param {number/string} value - The amount by which to increment the user property. Allows numbers as strings (ex: '123').
67+
* @param {number|string} value - The amount by which to increment the user property. Allows numbers as strings (ex: '123').
6868
* @return {Identify_object} Returns the same Identify object, allowing you to chain multiple method calls together.
6969
* @example var identify = new amplitude.Identify().add('karma', 1).add('friends', 1);
7070
* amplitude.identify(identify); // send the Identify call
@@ -84,7 +84,7 @@ <h1 class="page-title">Source: identify.js</h1>
8484
* If the user property has an existing value and it is not a list, the existing value will be converted into a list with the new values appended.
8585
* @public
8686
* @param {string} property - The user property key.
87-
* @param {number/string/list/object} value - A value or values to append. Values can be numbers, strings, lists, or object (key:value dict will be flattened).
87+
* @param {number|string|list|object} value - A value or values to append. Values can be numbers, strings, lists, or object (key:value dict will be flattened).
8888
* @return {Identify_object} Returns the same Identify object, allowing you to chain multiple method calls together.
8989
* @example var identify = new amplitude.Identify().append('ab-tests', 'new-user-tests');
9090
* identify.append('some_list', [1, 2, 3, 4, 'values']);
@@ -119,7 +119,7 @@ <h1 class="page-title">Source: identify.js</h1>
119119
* If the user property has an existing value and it is not a list, the existing value will be converted into a list with the new values prepended.
120120
* @public
121121
* @param {string} property - The user property key.
122-
* @param {number/string/list/object} value - A value or values to prepend. Values can be numbers, strings, lists, or object (key:value dict will be flattened).
122+
* @param {number|string|list|object} value - A value or values to prepend. Values can be numbers, strings, lists, or object (key:value dict will be flattened).
123123
* @return {Identify_object} Returns the same Identify object, allowing you to chain multiple method calls together.
124124
* @example var identify = new amplitude.Identify().prepend('ab-tests', 'new-user-tests');
125125
* identify.prepend('some_list', [1, 2, 3, 4, 'values']);
@@ -134,7 +134,7 @@ <h1 class="page-title">Source: identify.js</h1>
134134
* Sets the value of a given user property. If a value already exists, it will be overwriten with the new value.
135135
* @public
136136
* @param {string} property - The user property key.
137-
* @param {number/string/list/object} value - A value or values to set. Values can be numbers, strings, lists, or object (key:value dict will be flattened).
137+
* @param {number|string|list|object} value - A value or values to set. Values can be numbers, strings, lists, or object (key:value dict will be flattened).
138138
* @return {Identify_object} Returns the same Identify object, allowing you to chain multiple method calls together.
139139
* @example var identify = new amplitude.Identify().set('user_type', 'beta');
140140
* identify.set('name', {'first': 'John', 'last': 'Doe'}); // dict is flattened and becomes name.first: John, name.last: Doe
@@ -150,7 +150,7 @@ <h1 class="page-title">Source: identify.js</h1>
150150
* Useful for capturing properties such as 'initial_signup_date', 'initial_referrer', etc.
151151
* @public
152152
* @param {string} property - The user property key.
153-
* @param {number/string/list/object} value - A value or values to set once. Values can be numbers, strings, lists, or object (key:value dict will be flattened).
153+
* @param {number|string|list|object} value - A value or values to set once. Values can be numbers, strings, lists, or object (key:value dict will be flattened).
154154
* @return {Identify_object} Returns the same Identify object, allowing you to chain multiple method calls together.
155155
* @example var identify = new amplitude.Identify().setOnce('sign_up_date', '2016-04-01');
156156
* amplitude.identify(identify); // send the Identify call
@@ -215,7 +215,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Amplitude
215215
<br class="clear">
216216

217217
<footer>
218-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Fri Apr 01 2016 16:04:25 GMT-0700 (PDT)
218+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Fri Apr 01 2016 16:45:14 GMT-0700 (PDT)
219219
</footer>
220220

221221
<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 Fri Apr 01 2016 16:04:25 GMT-0700 (PDT)
59+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Fri Apr 01 2016 16:45:14 GMT-0700 (PDT)
6060
</footer>
6161

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

src/identify.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ var Identify = function() {
3636
* Increment a user property by a given value (can also be negative to decrement). If the user property does not have a value set yet, it will be initialized to 0 before being incremented.
3737
* @public
3838
* @param {string} property - The user property key.
39-
* @param {number/string} value - The amount by which to increment the user property. Allows numbers as strings (ex: '123').
39+
* @param {number|string} value - The amount by which to increment the user property. Allows numbers as strings (ex: '123').
4040
* @return {Identify_object} Returns the same Identify object, allowing you to chain multiple method calls together.
4141
* @example var identify = new amplitude.Identify().add('karma', 1).add('friends', 1);
4242
* amplitude.identify(identify); // send the Identify call
@@ -56,7 +56,7 @@ Identify.prototype.add = function(property, value) {
5656
* If the user property has an existing value and it is not a list, the existing value will be converted into a list with the new values appended.
5757
* @public
5858
* @param {string} property - The user property key.
59-
* @param {number/string/list/object} value - A value or values to append. Values can be numbers, strings, lists, or object (key:value dict will be flattened).
59+
* @param {number|string|list|object} value - A value or values to append. Values can be numbers, strings, lists, or object (key:value dict will be flattened).
6060
* @return {Identify_object} Returns the same Identify object, allowing you to chain multiple method calls together.
6161
* @example var identify = new amplitude.Identify().append('ab-tests', 'new-user-tests');
6262
* identify.append('some_list', [1, 2, 3, 4, 'values']);
@@ -91,7 +91,7 @@ Identify.prototype.clearAll = function() {
9191
* If the user property has an existing value and it is not a list, the existing value will be converted into a list with the new values prepended.
9292
* @public
9393
* @param {string} property - The user property key.
94-
* @param {number/string/list/object} value - A value or values to prepend. Values can be numbers, strings, lists, or object (key:value dict will be flattened).
94+
* @param {number|string|list|object} value - A value or values to prepend. Values can be numbers, strings, lists, or object (key:value dict will be flattened).
9595
* @return {Identify_object} Returns the same Identify object, allowing you to chain multiple method calls together.
9696
* @example var identify = new amplitude.Identify().prepend('ab-tests', 'new-user-tests');
9797
* identify.prepend('some_list', [1, 2, 3, 4, 'values']);
@@ -106,7 +106,7 @@ Identify.prototype.prepend = function(property, value) {
106106
* Sets the value of a given user property. If a value already exists, it will be overwriten with the new value.
107107
* @public
108108
* @param {string} property - The user property key.
109-
* @param {number/string/list/object} value - A value or values to set. Values can be numbers, strings, lists, or object (key:value dict will be flattened).
109+
* @param {number|string|list|object} value - A value or values to set. Values can be numbers, strings, lists, or object (key:value dict will be flattened).
110110
* @return {Identify_object} Returns the same Identify object, allowing you to chain multiple method calls together.
111111
* @example var identify = new amplitude.Identify().set('user_type', 'beta');
112112
* identify.set('name', {'first': 'John', 'last': 'Doe'}); // dict is flattened and becomes name.first: John, name.last: Doe
@@ -122,7 +122,7 @@ Identify.prototype.set = function(property, value) {
122122
* Useful for capturing properties such as 'initial_signup_date', 'initial_referrer', etc.
123123
* @public
124124
* @param {string} property - The user property key.
125-
* @param {number/string/list/object} value - A value or values to set once. Values can be numbers, strings, lists, or object (key:value dict will be flattened).
125+
* @param {number|string|list|object} value - A value or values to set once. Values can be numbers, strings, lists, or object (key:value dict will be flattened).
126126
* @return {Identify_object} Returns the same Identify object, allowing you to chain multiple method calls together.
127127
* @example var identify = new amplitude.Identify().setOnce('sign_up_date', '2016-04-01');
128128
* amplitude.identify(identify); // send the Identify call

0 commit comments

Comments
 (0)