Mirrors/lodash
1
0
Fork 0
mirror of https://github.com/whoisclebs/lodash.git synced 2026-02-03 00:27:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve jsdoc syntax. [closes #334]

Browse Source 
Former-commit-id: a6ab2e8ac7c5b8abd0e63ee025552d6452a3e0a2
This commit is contained in:
John-David Dalton
2013-08-25 13:01:41 -07:00
parent 4d7a1199ea
commit 83b5806cec
16 changed files with 2157 additions and 2184 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
test/test-build.js
View File

@@ -331,8 +331,8 @@
* Capitalizes a given string.
*
* @private
* @param {String} string The string to capitalize.
* @returns {String} Returns the capitalized string.
* @param {string} string The string to capitalize.
* @returns {string} Returns the capitalized string.
*/
function capitalize(string) {
return string[0].toUpperCase() + string.slice(1);
@@ -342,7 +342,7 @@
* Creates a context object to use with `vm.runInContext`.
*
* @private
* @returns {Object} Returns a new context object.
* @returns {object} Returns a new context object.
*/
function createContext() {
return vm.createContext({
@@ -356,8 +356,8 @@
* Expands a list of function names to include real and alias names.
*
* @private
* @param {Array} funcNames The array of function names to expand.
* @returns {Array} Returns a new array of expanded function names.
* @param {array} funcNames The array of function names to expand.
* @returns {array} Returns a new array of expanded function names.
*/
function expandFuncNames(funcNames) {
return funcNames.reduce(function(result, funcName) {
@@ -371,8 +371,8 @@
* Gets the aliases associated with a given function name.
*
* @private
* @param {String} funcName The name of the function to get aliases for.
* @returns {Array} Returns an array of aliases.
* @param {string} funcName The name of the function to get aliases for.
* @returns {array} Returns an array of aliases.
*/
function getAliases(funcName) {
return realToAliasMap[funcName] || [];
@@ -382,8 +382,8 @@
* Gets the real name, not alias, of a given function name.
*
* @private
* @param {String} funcName The name of the function to resolve.
* @returns {String} Returns the real name.
* @param {string} funcName The name of the function to resolve.
* @returns {string} Returns the real name.
*/
function getRealName(funcName) {
return aliasToRealMap[funcName] || funcName;
@@ -393,9 +393,9 @@
* Tests if a given method can be called successfully.
*
* @private
* @param {Object} lodash The built Lo-Dash object.
* @param {String} funcName The name of the method to test.
* @param {String} message The unit test message.
* @param {object} lodash The built Lo-Dash object.
* @param {string} funcName The name of the method to test.
* @param {string} message The unit test message.
*/
function testMethod(lodash, methodName, message) {
var pass = true,

4
test/test-ui.js
View File

@@ -20,8 +20,8 @@
*
* @private
* @param {Element} element The element.
* @param {String} eventName The name of the event.
* @param {Function} handler The event handler.
* @param {string} eventName The name of the event.
* @param {function} handler The event handler.
* @returns {Element} The element.
*/
function addListener(element, eventName, handler) {

2
test/test.js
View File

@@ -109,7 +109,7 @@
* Skips a given number of tests with a passing result.
*
* @private
* @param {Number} [count=1] The number of tests to skip.
* @param {number} [count=1] The number of tests to skip.
*/
function skipTest(count) {
count || (count = 1);