API page: http://api.drupal.org/api/drupal/modules--node--node.module/function/nod...

The "Parameters" section is showing HTML tags as if they were plain text.

The issue is also present in the pages for Drupal 6, and Drupal 7.

CommentFileSizeAuthor
#3 fix-node-title-list-doc_patch1_1264894_2.patch857 bytesJames_Stallings
#1 fix-node-title-list-documentation-formatting-1264894.patch683 bytesdevin carlson
node_title_list | Drupal API.png31.33 KBavpaderno

Comments

avpaderno’s picture

avpaderno
he/him
Primary language Italian
Location Brescia, 🇮🇹 🇪🇺
commented
Issue summary: View changes

Inlined the screenshot.

devin carlson’s picture

devin carlson commented
Status: Active » Needs review
StatusFileSize
new fix-node-title-list-documentation-formatting-1264894.patch683 bytes

After checking out the Doxygen formatting conventions and referencing other parts of the module, I think node_comment_statistics should be wrapped in curly brackets and comment_count should be wrapped in quotation marks (the existing code tags should be removed).

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Needs review » Needs work
Issue tags: +Needs backport to D7

Thanks for the patch!

The curly brackets are definitely a good idea. I think the field name doesn't need to be in quotes though?

Also, could you:
a) Change "DB" to "database" in the first line of that @param
b) Re-wrap the paragraph lines so they are as close to 80 characters as possible without going over

Thanks!

James_Stallings’s picture

James_Stallings commented
Status: Needs work » Needs review
StatusFileSize
new fix-node-title-list-doc_patch1_1264894_2.patch857 bytes
jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Needs review » Reviewed & tested by the community

Thanks! Looks good to me, for 7.x/8.x.

catch’s picture

catch
he/him
Primary language English
commented
Version: 8.x-dev » 7.x-dev

Committed to 8.x, moving to 7.x for webchick.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

#3: fix-node-title-list-doc_patch1_1264894_2.patch queued for re-testing.

webchick’s picture

webchick
she/they
Primary language English
Location Vancouver 🇨🇦
commented
Status: Reviewed & tested by the community » Fixed

Committed and pushed to 7.x. Thanks!

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

Anonymous’s picture

(not verified) commented
Issue summary: View changes

Added a reference to the pages for the other Drupal versions.