Remove "@param and @return syntax does not indicate the data type" rule [#1361528]

In #711918: Documentation standard for @param and @return data types, @param data types are being added to the doxygen standards for D8.

Morbus suggested in #1360276-5: Add xjm as maintainer or co-maintainer? that rules for this standard should be added to Coder Review rather than this project. However, we should remove the existing rule and allow Coder Review to handle them as appropriate (required for D8, and possibly disallowed in D7).

Comment	File	Size	Author
#4	coder_tough_love-1361528-4.patch	1.35 KB	danepowell
#3	coder_tough_love-1361528-3.patch	1.26 KB	danepowell
#1	remove-param-return-datatype.patch	1.16 KB	xjm

Comments

Comment #0.0

xjm

she/her

English

commented 5 December 2011 at 15:26

Issue summary:

View changes

Updated issue summary.

Comment #0.1

xjm

she/her

English

commented 5 December 2011 at 15:26

Issue summary:

View changes

Updated issue summary.

Comment #1

xjm

she/her

English

commented 7 December 2011 at 16:02

Status:

Active

» Needs review

Status	File	Size
new	remove-param-return-datatype.patch	1.16 KB

Attached patch simply removes this warning.

Comment #2

danepowell commented 16 December 2011 at 19:20

+1... will test this out and report back

Comment #3

danepowell commented 16 December 2011 at 20:05

Status	File	Size
new	coder_tough_love-1361528-3.patch	1.26 KB

Patch in #1 doesn't apply cleanly to HEAD- here's an updated patch.

Comment #4

danepowell commented 16 December 2011 at 20:36

Status	File	Size
new	coder_tough_love-1361528-4.patch	1.35 KB

My bad... please ignore #3. The patch failed to apply due to a misconfiguration.

However, I found another very similar bug- 'object' is not recognized as a valid Doxygen return type. The attached patch adds 'object' to the valid return types.

Since technically any sort of class can now be defined as a return type, should this rule be changed in a more general way? Maybe to look for spaces that would indicate a description rather than a return type?