Add @return values and @param in the comment docblocks and removal of unused local variables.

CommentFileSizeAuthor
#5 2604866-5.patch2.22 KBheykarthikwithu
#3 2604866.patch2.51 KBheykarthikwithu

Comments

heykarthikwithu created an issue. See original summary.

heykarthikwithu’s picture

heykarthikwithu
Primary language English
Location Bengaluru 🌍
commented
Title: Add @return values in the comment docblocks and removal of unused local variables.Add @return values in the comment docblocks and removal of unused local variables. » Add @return values in the comment docblocks and removal of unused local variables.
heykarthikwithu’s picture

heykarthikwithu
Primary language English
Location Bengaluru 🌍
commented
Assigned: heykarthikwithu » Unassigned
Status: Active » Needs review
StatusFileSize
new 2604866.patch2.51 KB

added a patch which added @return and @param in comment blocks and removes unused variables.

balintcsaba’s picture

balintcsaba commented
Status: Needs review » Needs work

Hi

For the cacheflush.module is ok the patch, but for the others is problem with Coding standards.

You added 

 * @param array $form
 * @param array $form_state

without comment on the param's.

But I think that in this case we don't need to explain the param's and the return values because is a callback function.
In this case is more indicated to do something like this:

/**
 * Comment of the function.
 *
 * @see ajax_get_form()
 */
heykarthikwithu’s picture

heykarthikwithu
Primary language English
Location Bengaluru 🌍
commented
Status: Needs work » Needs review
StatusFileSize
new 2604866-5.patch2.22 KB

hi, recreated the patch with the changes.

balintcsaba’s picture

balintcsaba commented
Status: Needs review » Fixed

Status: Fixed » Closed (fixed)

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