/**
 * Given an API username, retrieve the site nid.
 *
 * @param $username
 *
 * @return int
 */

Causes:

 102 | ERROR   | [ ] Return comment must be on the next line

Comments

klausi’s picture

klausi
he/him||they/them
Primary language German
Location 🇦🇹 Vienna
commented
Status: Active » Closed (works as designed)

Yes, because you are missing a description comment for the @return tag on the next line.

psynaptic’s picture

psynaptic commented

Yes but shouldn't it say "Missing description for @return tag", or something to that effect?

Anonymous’s picture

Anonymous (not verified) commented
Issue summary: View changes

This still needs to be modified. It is not clear what the sniffer asks for. I lost like 20 minutes to understand that it actually needs a description.

Anonymous’s picture

Anonymous (not verified) commented
Status: Closed (works as designed) » Active
klausi’s picture

klausi
he/him||they/them
Primary language German
Location 🇦🇹 Vienna
commented
Status: Closed (works as designed) » Active

  • klausi committed a5b5f6b on 8.x-2.x 
    Issue #2222691: "Improved @return comment error message
klausi’s picture

klausi
he/him||they/them
Primary language German
Location 🇦🇹 Vienna
commented
Title: "Return comment must be on the next line" triggers for @return with data-type » Improve @return comment error message
Status: Active » Fixed

committed a fix.

Status: Fixed » Closed (fixed)

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