Tools: document test.js #4141

Closed
opened 2025-11-26 20:56:58 -06:00 by GiteaMirror · 1 comment
Owner

Originally created by @nodiscc on GitHub (Apr 4, 2017).

Originally assigned to: @n8225 on GitHub.

Followup to #875

@n8225 Can you document the test.js file a bit? Ideally with comment blocks for each function/...

/*!
 * What the function does
 * \fn function(example, others)
 * \param string example An example parameter
 * \param array others (optional) An array of optional parameters
 * \return string Value returned by this function
 */

I have very little experience of JavaScript and a properly commented script will make maintenance/modification/comprehension of this script easier.

Originally created by @nodiscc on GitHub (Apr 4, 2017). Originally assigned to: @n8225 on GitHub. Followup to #875 @n8225 Can you document the test.js file a bit? Ideally with comment blocks for each function/... ``` /*! * What the function does * \fn function(example, others) * \param string example An example parameter * \param array others (optional) An array of optional parameters * \return string Value returned by this function */ ``` I have very little experience of JavaScript and a properly commented script will make maintenance/modification/comprehension of this script easier.
GiteaMirror added the fix label 2025-11-26 20:56:58 -06:00
Author
Owner

@Kickball commented on GitHub (Apr 17, 2017):

This has been documented in #1024.

@Kickball commented on GitHub (Apr 17, 2017): This has been documented in #1024.
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/awesome-selfhosted#4141