Add @return type and @param values in the comment docblocks.

Comments

aditya_anurag created an issue. See original summary.

aditya_anurag’s picture

StatusFileSize
new1.98 KB

Added a patch for this.

aditya_anurag’s picture

Assigned: aditya_anurag » Unassigned
Status: Active » Needs review
aditya_anurag’s picture

Issue tags: +Novice
hgoto’s picture

Status: Needs review » Needs work

@aditya_anurag, I saw your patch and noticed some points to improve.

- Docblocks need a blank line between the first line such as * Implements hook_install_tasks() and the rest.
- Docblocks also need a blank line between @param group and @return.
- The descriptions for @param and @return are not inconsistent in the code. If you want to improve the docblock, Isn't it better to add descriptions to all of new @param and @return?
- @internal may not be necessary.

Please try seeing the documentation standard again.

https://www.drupal.org/coding-standards/docs

rasikap’s picture

Assigned: Unassigned » rasikap
rasikap’s picture

Status: Needs work » Needs review
StatusFileSize
new7.33 KB

Added patch for this issue. Also fixed some coding standard issues.

rasikap’s picture

Assigned: rasikap » Unassigned
dsnopek’s picture

Status: Needs review » Needs work

Thanks for the contribution!

This also appears to do some trailing whitespace fixing, which I guess is fine since we don't have (that I'm aware of) other patches working on this same code. Usually, we like to isolate whitespace fixes to their own issues because they break other patches.

One small bit of review:

+++ b/.gitignore
@@ -4,3 +4,4 @@ vendor
+/nbproject/private/

This looks like an unintentional addition?

rasikap’s picture

Assigned: Unassigned » rasikap
rasikap’s picture

Hi dsnopek,

So I would just need to remove the unintentional addition correct? or is there anything more that needs to be changed?

dsnopek’s picture

So I would just need to remove the unintentional addition correct?

Yes, please! Thanks in advance :-)

rasikap’s picture

StatusFileSize
new7.07 KB

Added patch after removing unintentional addition.

rasikap’s picture

Assigned: rasikap » Unassigned
rasikap’s picture

Status: Needs work » Needs review
Christie Alcidor’s picture