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

CommentFileSizeAuthor
#10 2611480-10.patch2.01 KBheykarthikwithu
#6 interdiff-2611480-2-6.txt3.26 KBaditya_anurag
#6 nodequeue-2611480-6.patch9.35 KBaditya_anurag
#2 nodequeue-2611480-2.patch9.71 KBaditya_anurag

Comments

aditya_anurag created an issue. See original summary.

aditya_anurag’s picture

aditya_anurag commented
StatusFileSize
new nodequeue-2611480-2.patch9.71 KB

Added a patch for this.

aditya_anurag’s picture

aditya_anurag commented
Assigned: aditya_anurag » Unassigned
Status: Needs work » Needs review
fizk’s picture

fizk commented

Thanks for the patch! I'm seeing inconsistent indentation for comments:

  1. +++ b/nodequeue.module
@@ -2096,14 +2121,14 @@ function nodequeue_api_subqueue_access($subqueue, $account = NULL, $queue = NULL
+ * @return array|string
+ * The query string suitable for use in the l() function.

    Comment is not indented here. 

  2. +++ b/includes/nodequeue.admin.inc
@@ -105,6 +105,9 @@ function nodequeue_admin_remove_node($queue, $subqueue, $node) {
+ * @return string
+ *   return data in html table

    Comment is indented here.

Can we go with indentations for all comment lines?

aditya_anurag’s picture

aditya_anurag commented
Assigned: Unassigned » aditya_anurag
Status: Needs review » Needs work

Hey @fizk
Thanks for informing inconsistent indentation for comments.

i will look into. and will apply appropriate patch for the above.

aditya_anurag’s picture

aditya_anurag commented
Assigned: aditya_anurag » Unassigned
Status: Needs work » Needs review
StatusFileSize
new nodequeue-2611480-6.patch9.35 KB
new interdiff-2611480-2-6.txt3.26 KB

applied new patch.

fizk’s picture

fizk commented
Status: Needs review » Fixed

Committed, thanks!

  • fizk committed 603fa5c on 7.x-2.x authored by aditya_anurag 
    Issue #2611480 by aditya_anurag: Add @return type and @param values in...
heykarthikwithu’s picture

heykarthikwithu
Primary language English
Location Bengaluru 🌍
commented
Assigned: Unassigned » heykarthikwithu
heykarthikwithu’s picture

heykarthikwithu
Primary language English
Location Bengaluru 🌍
commented
Version: 7.x-2.0 » 7.x-2.x-dev
Assigned: heykarthikwithu » Unassigned
Status: Fixed » Needs review
StatusFileSize
new 2611480-10.patch2.01 KB

Added @return types and @param values in few more places.

fizk’s picture

fizk commented
Status: Needs review » Fixed

Committed, thanks again.

  • fizk committed 235b800 on 7.x-2.x authored by heykarthikwithu 
    Issue #2611480 by aditya_anurag, heykarthikwithu: Add @return type and @...

Status: Fixed » Closed (fixed)

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