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

CommentFileSizeAuthor
#4 2611716-4--documentation_improvements.patch14.25 KBdrunken monkey
#4 2611716-4--documentation_improvements--interdiff.txt16.38 KBdrunken monkey
#2 search_api_solr-2611716-2.patch7.84 KBaditya_anurag

Comments

aditya_anurag created an issue. See original summary.

aditya_anurag’s picture

aditya_anurag commented
Assigned: aditya_anurag » Unassigned
Status: Needs work » Needs review
StatusFileSize
new search_api_solr-2611716-2.patch7.84 KB

Added a patch for this.

aditya_anurag’s picture

aditya_anurag commented
Issue tags: +Documentation
drunken monkey’s picture

drunken monkey
he/him
Primary language German
Location Vienna, Austria
commented
StatusFileSize
new 2611716-4--documentation_improvements--interdiff.txt16.38 KB
new 2611716-4--documentation_improvements.patch14.25 KB

Great work, thanks a lot!

However, according to the Drupal coding standards, @inheritdoc should be used for implementing/overriding methods, unless there's something specific to add to the documentation. I had that wrong before, it's old code, but we should correct that rather than just also add @param/@return documentation.

Also, hook implementations also don't need any further documentation, that is already provided with the hook definition.

Please see the attached patch for my tweaks.

drunken monkey’s picture

drunken monkey
he/him
Primary language German
Location Vienna, Austria
commented
Status: Needs review » Fixed

Committed.
Thanks again for your contribution!

Status: Fixed » Closed (fixed)

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