Come together with the global Drupal community in Rotterdam, 28 Sept – 1 Oct 2026. Sessions, contribution, connection, and Early Bird savings until 8 June."@see directives should always be placed on their own line"
patch coming.
| Comment | File | Size | Author |
|---|---|---|---|
| #4 | 1089332_at_see_doc_2.patch | 1.47 KB | jeffschuler |
| #5 | 1089332_at_see_doc_5.patch | 1.38 KB | jeffschuler |
| #1 | 1089332_at_see_doc_1.patch | 1.41 KB | jeffschuler |
Comments
Comment #1
jeffschulermoved @see to its own line
Comment #2
jeffschulersee "See Also sections" in Doxygen and comment formatting conventions for instructions on how @see should appear in comments.
Comment #3
jhodgdonThe docblocks in the original code are incorrect, but I am not entirely happy with this fix. When you put in @see, it makes a completely separate See Also section at the bottom of the doc page. I would prefer to just change the word "@see" in the original to "See", because that would leave the reference where it is relevant.
Also, if you do use @see, it should normally be at the bottom of the docblock as per guidelines.
Comment #4
jeffschulerUnderstood and agreed.
I've removed the @see entirely, (which was, btw, at the bottom of the docblock.)
Those functions will get linked anyway.
[UPDATE: this patch actually changes the param text to See but leaves the new @see's around on their own lines.]
Comment #5
jeffschulerThat last patch kept the @see's at the end around. This one removes them...
Comment #6
jhodgdonLooks good to me, thanks!
Comment #8
jhodgdonThis is the usual d6 patch failure, so ignore that.
Comment #9
rfay#5: 1089332_at_see_doc_5.patch queued for re-testing.
Comment #10
gábor hojtsyOk I assume this does not apply to Drupal 8/7 since the DB layer was entirely overhauled. So committed and pushed. Thanks.