Skip to content

Commit 92a1d3d

Browse files
davepagurekdavepagurek
committed
Add deprecation info for p5.Table and splitTokens
1 parent 0906c29 commit 92a1d3d

File tree

6 files changed

+70
-41
lines changed

6 files changed

+70
-41
lines changed

‎docs/parameterData.json

Lines changed: 17 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -367,7 +367,18 @@
367367
"worldToScreen": {
368368
"overloads": [
369369
[
370-
"p5.Vector"
370+
"Number|p5.Vector",
371+
"Number",
372+
"Number?"
373+
]
374+
]
375+
},
376+
"screenToWorld": {
377+
"overloads": [
378+
[
379+
"Number|p5.Vector",
380+
"Number",
381+
"Number?"
371382
]
372383
]
373384
},
@@ -1968,24 +1979,6 @@
19681979
]
19691980
]
19701981
},
1971-
"quadraticVertex": {
1972-
"overloads": [
1973-
[
1974-
"Number",
1975-
"Number",
1976-
"Number",
1977-
"Number"
1978-
],
1979-
[
1980-
"Number",
1981-
"Number",
1982-
"Number",
1983-
"Number",
1984-
"Number",
1985-
"Number"
1986-
]
1987-
]
1988-
},
19891982
"normal": {
19901983
"overloads": [
19911984
[
@@ -2839,6 +2832,11 @@
28392832
[]
28402833
]
28412834
},
2835+
"baseFilterShader": {
2836+
"overloads": [
2837+
[]
2838+
]
2839+
},
28422840
"baseNormalShader": {
28432841
"overloads": [
28442842
[]
@@ -3355,27 +3353,6 @@
33553353
]
33563354
]
33573355
},
3358-
"touchStarted": {
3359-
"overloads": [
3360-
[
3361-
"Function|Boolean"
3362-
]
3363-
]
3364-
},
3365-
"touchMoved": {
3366-
"overloads": [
3367-
[
3368-
"Function|Boolean"
3369-
]
3370-
]
3371-
},
3372-
"touchEnded": {
3373-
"overloads": [
3374-
[
3375-
"Function|Boolean"
3376-
]
3377-
]
3378-
},
33793356
"dragOver": {
33803357
"overloads": [
33813358
[

‎src/io/files.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -470,6 +470,7 @@ function files(p5, fn){
470470
* All files loaded and saved use UTF-8 encoding. This method is suitable for fetching files up to size of 64MB.
471471
*
472472
* @method loadTable
473+
* @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
473474
* @param {String|Request} filename name of the file or URL to load
474475
* @param {String} [separator] the separator character used by the file, defaults to `','`
475476
* @param {String} [header] "header" to indicate table has header row
@@ -1987,6 +1988,7 @@ function files(p5, fn){
19871988
* vary between web browsers.
19881989
*
19891990
* @method saveTable
1991+
* @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
19901992
* @param {p5.Table} Table the <a href="#/p5.Table">Table</a> object to save to a file
19911993
* @param {String} filename the filename to which the Table should be saved
19921994
* @param {String} [options] can be one of "tsv", "csv", or "html"

‎src/io/p5.Table.js

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ function table(p5, fn){
3737
* scratch, dynamically, or using data from an existing file.
3838
*
3939
* @class p5.Table
40+
* @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
4041
* @param {p5.TableRow[]} [rows] An array of p5.TableRow objects
4142
*/
4243
p5.Table = class Table {
@@ -66,6 +67,7 @@ function table(p5, fn){
6667
* If a <a href="#/p5.TableRow">p5.TableRow</a> object is included as a parameter, then that row is
6768
* duplicated and added to the table.
6869
*
70+
* @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
6971
* @param {p5.TableRow} [row] row to be added to the table
7072
* @return {p5.TableRow} the row that was added
7173
*
@@ -119,6 +121,7 @@ function table(p5, fn){
119121
/**
120122
* Removes a row from the table object.
121123
*
124+
* @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
122125
* @param {Integer} id ID number of the row to remove
123126
*
124127
* @example
@@ -163,6 +166,7 @@ function table(p5, fn){
163166
* Returns a reference to the specified <a href="#/p5.TableRow">p5.TableRow</a>. The reference
164167
* can then be used to get and set values of the selected row.
165168
*
169+
* @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
166170
* @param {Integer} rowID ID number of the row to get
167171
* @return {p5.TableRow} <a href="#/p5.TableRow">p5.TableRow</a> object
168172
*
@@ -203,6 +207,7 @@ function table(p5, fn){
203207
/**
204208
* Gets all rows from the table. Returns an array of <a href="#/p5.TableRow">p5.TableRow</a>s.
205209
*
210+
* @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
206211
* @return {p5.TableRow[]} Array of <a href="#/p5.TableRow">p5.TableRow</a>s
207212
*
208213
* @example
@@ -251,6 +256,7 @@ function table(p5, fn){
251256
* row is returned. The column to search may be specified by
252257
* either its ID or title.
253258
*
259+
* @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
254260
* @param {String} value The value to match
255261
* @param {Integer|String} column ID number or title of the
256262
* column to search
@@ -310,6 +316,7 @@ function table(p5, fn){
310316
* as shown in the example above. The column to search may be
311317
* specified by either its ID or title.
312318
*
319+
* @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
313320
* @param {String} value The value to match
314321
* @param {Integer|String} column ID number or title of the
315322
* column to search
@@ -373,6 +380,7 @@ function table(p5, fn){
373380
* matching row is returned. The column to search may be
374381
* specified by either its ID or title.
375382
*
383+
* @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
376384
* @param {String|RegExp} regexp The regular expression to match
377385
* @param {String|Integer} column The column ID (number) or
378386
* title (string)
@@ -427,6 +435,7 @@ function table(p5, fn){
427435
* used to iterate through all the rows, as shown in the example. The
428436
* column to search may be specified by either its ID or title.
429437
*
438+
* @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
430439
* @param {String} regexp The regular expression to match
431440
* @param {String|Integer} [column] The column ID (number) or
432441
* title (string)
@@ -491,6 +500,7 @@ function table(p5, fn){
491500
* Retrieves all values in the specified column, and returns them
492501
* as an array. The column may be specified by either its ID or title.
493502
*
503+
* @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
494504
* @param {String|Number} column String or Number of the column to return
495505
* @return {Array} Array of column values
496506
*
@@ -538,6 +548,8 @@ function table(p5, fn){
538548
* Removes all rows from a Table. While all rows are removed,
539549
* columns and column titles are maintained.
540550
*
551+
* @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
552+
*
541553
* @example
542554
* <div class="norender">
543555
* <code>
@@ -575,6 +587,7 @@ function table(p5, fn){
575587
* may be easily referenced later by name. (If no title is
576588
* specified, the new column's title will be null.)
577589
*
590+
* @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
578591
* @param {String} [title] title of the given column
579592
*
580593
* @example
@@ -618,6 +631,7 @@ function table(p5, fn){
618631
/**
619632
* Returns the total number of columns in a Table.
620633
*
634+
* @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
621635
* @return {Integer} Number of columns in this table
622636
* @example
623637
* <div>
@@ -651,6 +665,7 @@ function table(p5, fn){
651665
/**
652666
* Returns the total number of rows in a Table.
653667
*
668+
* @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
654669
* @return {Integer} Number of rows in this table
655670
* @example
656671
* <div>
@@ -688,6 +703,7 @@ function table(p5, fn){
688703
* rows are processed. A specific column may be referenced by
689704
* either its ID or title.
690705
*
706+
* @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
691707
* @param {String} chars String listing characters to be removed
692708
* @param {String|Integer} [column] Column ID (number)
693709
* or name (string)
@@ -758,6 +774,7 @@ function table(p5, fn){
758774
* values in all columns and rows are trimmed. A specific column
759775
* may be referenced by either its ID or title.
760776
*
777+
* @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
761778
* @param {String|Integer} [column] Column ID (number)
762779
* or name (string)
763780
* @example
@@ -822,6 +839,7 @@ function table(p5, fn){
822839
* removeColumn(0) would remove the first column, removeColumn(1)
823840
* would remove the second column, and so on.
824841
*
842+
* @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
825843
* @param {String|Integer} column columnName (string) or ID (number)
826844
*
827845
* @example
@@ -879,6 +897,7 @@ function table(p5, fn){
879897
* The row is specified by its ID, while the column may be specified
880898
* by either its ID or title.
881899
*
900+
* @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
882901
* @param {Integer} row row ID
883902
* @param {String|Integer} column column ID (Number)
884903
* or title (String)
@@ -924,6 +943,7 @@ function table(p5, fn){
924943
* The row is specified by its ID, while the column may be specified
925944
* by either its ID or title.
926945
*
946+
* @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
927947
* @param {Integer} row row ID
928948
* @param {String|Integer} column column ID (Number)
929949
* or title (String)
@@ -966,6 +986,7 @@ function table(p5, fn){
966986
* The row is specified by its ID, while the column may be specified
967987
* by either its ID or title.
968988
*
989+
* @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
969990
* @param {Integer} row row ID
970991
* @param {String|Integer} column column ID (Number)
971992
* or title (String)
@@ -1007,6 +1028,7 @@ function table(p5, fn){
10071028
* The row is specified by its ID, while the column may be specified by
10081029
* either its ID or title.
10091030
*
1031+
* @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
10101032
* @param {Integer} row row ID
10111033
* @param {String|Integer} column columnName (string) or
10121034
* ID (number)
@@ -1048,6 +1070,7 @@ function table(p5, fn){
10481070
* The row is specified by its ID, while the column may be specified by
10491071
* either its ID or title.
10501072
*
1073+
* @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
10511074
* @param {Integer} row row ID
10521075
* @param {String|Integer} column columnName (string) or
10531076
* ID (number)
@@ -1087,6 +1110,7 @@ function table(p5, fn){
10871110
* The row is specified by its ID, while the column may be specified by
10881111
* either its ID or title.
10891112
*
1113+
* @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
10901114
* @param {Integer} row row ID
10911115
* @param {String|Integer} column columnName (string) or
10921116
* ID (number)
@@ -1133,6 +1157,7 @@ function table(p5, fn){
11331157
* passed in, each row object will be stored with that attribute as its
11341158
* title.
11351159
*
1160+
* @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
11361161
* @param {String} [headerColumn] Name of the column which should be used to
11371162
* title each row object (optional)
11381163
* @return {Object}
@@ -1190,6 +1215,7 @@ function table(p5, fn){
11901215
/**
11911216
* Retrieves all table data and returns it as a multidimensional array.
11921217
*
1218+
* @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
11931219
* @return {Array}
11941220
*
11951221
* @example
@@ -1231,6 +1257,7 @@ function table(p5, fn){
12311257
/**
12321258
* An array containing the names of the columns in the table, if the "header" the table is
12331259
* loaded with the "header" parameter.
1260+
* @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
12341261
* @type {String[]}
12351262
* @property columns
12361263
* @for p5.Table
@@ -1267,6 +1294,7 @@ function table(p5, fn){
12671294
* rows of the table. The same result as calling <a href="/reference/p5.Table/getRows/">getRows()</a>
12681295
* @type {p5.TableRow[]}
12691296
* @property rows
1297+
* @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
12701298
* @for p5.Table
12711299
* @name rows
12721300
*/

‎src/io/p5.TableRow.js

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ function tableRow(p5, fn){
1313
* JSON object.
1414
*
1515
* @class p5.TableRow
16+
* @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
1617
* @constructor
1718
* @param {any[]} row optional: populate the row with an
1819
* array of values
@@ -31,6 +32,7 @@ function tableRow(p5, fn){
3132
* The column may be specified by either its ID or title.
3233
*
3334
* @method set
35+
* @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
3436
* @param {String|Integer} column Column ID (Number)
3537
* or Title (String)
3638
* @param {String|Number} value The value to be stored
@@ -90,6 +92,7 @@ function tableRow(p5, fn){
9092
* The column may be specified by either its ID or title.
9193
*
9294
* @method setNum
95+
* @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
9396
* @param {String|Integer} column Column ID (Number)
9497
* or Title (String)
9598
* @param {Number|String} value The value to be stored
@@ -131,6 +134,7 @@ function tableRow(p5, fn){
131134
* The column may be specified by either its ID or title.
132135
*
133136
* @method setString
137+
* @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
134138
* @param {String|Integer} column Column ID (Number)
135139
* or Title (String)
136140
* @param {String|Number|Boolean|Object} value The value to be stored
@@ -173,6 +177,7 @@ function tableRow(p5, fn){
173177
* The column may be specified by either its ID or title.
174178
*
175179
* @method get
180+
* @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
176181
* @param {String|Integer} column columnName (string) or
177182
* ID (number)
178183
* @return {String|Number}
@@ -219,6 +224,7 @@ function tableRow(p5, fn){
219224
* title.
220225
*
221226
* @method getNum
227+
* @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
222228
* @param {String|Integer} column columnName (string) or
223229
* ID (number)
224230
* @return {Number} Float Floating point number
@@ -270,7 +276,9 @@ function tableRow(p5, fn){
270276
* column. The column may be specified by either its ID or
271277
* title.
272278
*
273-
* @method getString
279+
* @method getStri
280+
* @deprecated p5.Table will be removed in a future version of p5.js to make way for a new, friendlier version :)
281+
274282
* @param {String|Integer} column columnName (string) or
275283
* ID (number)
276284
* @return {String} String

‎src/utilities/string_functions.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -760,6 +760,7 @@ function stringFunctions(p5, fn){
760760
* carriage return (`\r`), form feed (`\f`), and space.
761761
*
762762
* @method splitTokens
763+
* @deprecated This will be removed in a future version of p5.js to make way for a new, friendlier version :)
763764
* @param {String} value string to split.
764765
* @param {String} [delim] character(s) to use for splitting the string.
765766
* @return {String[]} separated strings.

0 commit comments

Comments
 (0)