See #1049528-1: Change script example for drupal_parse_info_file() from .css to .js:

we should make the list adhere to Doxygen and comments coding conventions: Lists

And #1049528-2: Change script example for drupal_parse_info_file() from .css to .js:

Also: the correct puncutation for "eg" is "e.g.", and it should be preceded by a semicolon and followed by a comma (it means "for example" and should be punctuated the same):

features: Features available; e.g., features[] = logo.

CommentFileSizeAuthor
#3 1051184-drupal-parse-info-file.patch1.34 KBmr.baileys

Comments

jhodgdon’s picture

Thanks for filing this. I still would prefer that all of the issues get fixed on the other issue, but let's wait and see.

mr.baileys’s picture

Since #1049528: Change script example for drupal_parse_info_file() from .css to .js has been committed, this issue is now about the only remaining problem:

There seems to be more than just this wrong with this docblock -- some of the information is coming out at the end and some at the beginning of
http://api.drupal.org/api/drupal/includes--common.inc/function/drupal_pa...

mr.baileys’s picture

Status: Active » Needs review
StatusFileSize
new1.34 KB

It seems that the first @see directive causes the "end of doxygen"-block to be rendered, containing things like @param and @return. The content after the first @see is then spit out after that block, and all further directives are ignored (for example, the @see bartik.info is rendered as just "bartik"). This seems to contradict the Doxygen and comment coding conventions, which state that:

@see directives should always be placed on their own line, and generally at the bottom of the documentation header.

Anyway, patch attached that should fix the formatting issue on the api page.

jhodgdon’s picture

Status: Needs review » Reviewed & tested by the community

Interesting. I'll file an API module issue on that one. Normally @see shouldn't cause all that to happen, at least I don't think it should.

The fix here is fine. Those lines should not have been @see anyway -- much better to have the explanation as given in the patch here. Thanks!

jhodgdon’s picture

dries’s picture

Status: Reviewed & tested by the community » Fixed

Committed to CVS HEAD.

Status: Fixed » Closed (fixed)

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