diff options
| author | Tobias Witt <[email protected]> | 2016-03-02 15:21:54 +0100 |
|---|---|---|
| committer | Marak <[email protected]> | 2016-03-03 04:30:38 -0500 |
| commit | 90a6a04f9cd4a134fec20949e68beb4baf79bfae (patch) | |
| tree | 70ada7191ace4c22e7d6a5ffa4a65a92d65c92a9 /lib/hacker.js | |
| parent | 9bb2b7c341bcf41e00341c92a8a66620c401c85f (diff) | |
| download | faker-90a6a04f9cd4a134fec20949e68beb4baf79bfae.tar.xz faker-90a6a04f9cd4a134fec20949e68beb4baf79bfae.zip | |
Install jsdoc and add doclet stubs for all methods
Descriptions are taken from existing comments if available. The address module already has some new sample descriptions.
Diffstat (limited to 'lib/hacker.js')
| -rw-r--r-- | lib/hacker.js | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/lib/hacker.js b/lib/hacker.js index 463f8331..c87a8d28 100644 --- a/lib/hacker.js +++ b/lib/hacker.js @@ -1,26 +1,60 @@ +/** + * + * @namespace faker.hacker + */ var Hacker = function (faker) { var self = this; + /** + * abbreviation + * + * @method faker.hacker.abbreviation + */ self.abbreviation = function () { return faker.random.arrayElement(faker.definitions.hacker.abbreviation); }; + /** + * adjective + * + * @method faker.hacker.adjective + */ self.adjective = function () { return faker.random.arrayElement(faker.definitions.hacker.adjective); }; + /** + * noun + * + * @method faker.hacker.noun + */ self.noun = function () { return faker.random.arrayElement(faker.definitions.hacker.noun); }; + /** + * verb + * + * @method faker.hacker.verb + */ self.verb = function () { return faker.random.arrayElement(faker.definitions.hacker.verb); }; + /** + * ingverb + * + * @method faker.hacker.ingverb + */ self.ingverb = function () { return faker.random.arrayElement(faker.definitions.hacker.ingverb); }; + /** + * phrase + * + * @method faker.hacker.phrase + */ self.phrase = function () { var data = { |
