UNPKG

1.48 kBJavaScriptView Raw
1/**
2 * A bowl of non-spicy soup.
3 * @class
4 *//**
5 * A bowl of spicy soup.
6 * @class
7 * @param {number} spiciness - The spiciness of the soup, in Scoville heat units (SHU).
8 */
9function Soup(spiciness) {}
10
11/**
12 * Slurp the soup.
13 *//**
14 * Slurp the soup loudly.
15 * @param {number} dBA - The slurping volume, in A-weighted decibels.
16 */
17Soup.prototype.slurp = function(dBA) {};
18
19/**
20 * Salt the soup as needed, using a highly optimized soup-salting heuristic.
21 *//**
22 * Salt the soup, specifying the amount of salt to add.
23 * @variation mg
24 * @param {number} amount - The amount of salt to add, in milligrams.
25 */
26Soup.prototype.salt = function(amount) {};
27
28/**
29 * Heat the soup by the specified number of degrees.
30 * @param {number} degrees - The number of degrees, in Fahrenheit, by which to heat the soup.
31 *//**
32 * Heat the soup by the specified number of degrees.
33 * @variation 1
34 * @param {string} degrees - The number of degrees, in Fahrenheit, by which to heat the soup, but
35 * as a string for some reason.
36 *//**
37 * Heat the soup by the specified number of degrees.
38 * @param {boolean} degrees - The number of degrees, as a boolean. Wait, what?
39 */
40Soup.prototype.heat = function(degrees) {};
41
42/**
43 * Discard the soup.
44 * @variation discardSoup
45 *//**
46 * Discard the soup by pouring it into the specified container.
47 * @variation discardSoup
48 * @param {Object} container - The container in which to discard the soup.
49 */
50Soup.prototype.discard = function(container) {};