Adding JSDoc comments to the file module

CommentFileSizeAuthor
#7 core-jsdoc-file-2513560-7.patch3.19 KBnod_
#5 interdiff2513560-1-5.txt1.48 KBeiriksm
#5 jsdoc_file_module-2513560-5.patch3.21 KBeiriksm
#1 jsdoc_file_module-2513560-1.patch2.23 KBbohemier
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

bohemier’s picture

bohemier CreditAttribution: bohemier as a volunteer commented
Assigned: bohemier » Unassigned
Status: Active » Needs work
FileSize
jsdoc_file_module-2513560-1.patch2.23 KB

Started working on this, not done yet, here's my progress so far. Feel free to pick up on this issue.

Here's the outstanding eslint issues

file.js
  131:4  warning  Missing JSDoc parameter description for 'event'  valid-jsdoc
  167:4  warning  Missing JSDoc parameter description for 'event'  valid-jsdoc
  178:4  warning  Missing JSDoc parameter description for 'event'  valid-jsdoc
  215:4  warning  Missing JSDoc parameter description for 'event'  valid-jsdoc
  242:4  warning  Missing JSDoc parameter description for 'event'  valid-jsdoc

✖ 5 problems (0 errors, 5 warnings)
mparker17’s picture

mparker17
he/him
Primary language English
Location UTC-4
CreditAttribution: mparker17 at OpenConcept Consulting Inc. commented
Issue tags: +#DrupalNorth

Tagging as having been worked on at the DrupalNorth sprint

Anonymous’s picture

Anonymous (not verified) CreditAttribution: Anonymous as a volunteer commented
Issue tags: +DrupalNorth2015

Updating the issue tag to include a hashless DrupalNorth2015 on behalf of the Drupal North sprinting group.

mparker17’s picture

mparker17
he/him
Primary language English
Location UTC-4
CreditAttribution: mparker17 at OpenConcept Consulting Inc. commented
Issue tags: -#DrupalNorth

Removing old hashed tag.

eiriksm’s picture

eiriksm
he/him
Primary language Norwegian Bokmål
Location Norway
CreditAttribution: eiriksm at Ny Media AS commented
FileSize
jsdoc_file_module-2513560-5.patch3.21 KB
interdiff2513560-1-5.txt1.48 KB

Added the missing parameter comments.

eiriksm’s picture

eiriksm
he/him
Primary language Norwegian Bokmål
Location Norway
CreditAttribution: eiriksm at Ny Media AS commented
Status: Needs work » Needs review
nod_’s picture

nod_
Primary language French
Location Lille
CreditAttribution: nod_ as a volunteer commented
FileSize
core-jsdoc-file-2513560-7.patch3.19 KB

Added '.' and removed newlines where needed.

nod_’s picture

nod_
Primary language French
Location Lille
CreditAttribution: nod_ as a volunteer commented
Status: Needs review » Reviewed & tested by the community
webchick’s picture

webchick
she/they
Primary language English
Location Vancouver 🇨🇦
CreditAttribution: webchick at Acquia commented
Status: Reviewed & tested by the community » Fixed

Committed and pushed to 8.0.x. Thanks!

  • webchick committed cee2a48 on 8.0.x 
    Issue #2513560 by eiriksm, bohemier, nod_: JSDoc file module

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.