This is going to be an overview issue for smaller NEWLINE (no other problems) patches.
Marking this already as duplicate.

List with patches will follow soon.

CommentFileSizeAuthor
#3 855170.patch42.71 KBamateescu

Comments

jhodgdon’s picture

Title: Fix remaining newline issues in .inc files » Some docblocks lack blank line before @return section
Priority: Minor » Normal

Dries requested on #855324: Fix newlines in install.inc (comment #11) that we combine all the "fix newlines" issues into one patch.

Webchick suggested on #855410: Add missing doc and newlines in updater.inc (comment #7) that a better approach would be to write a script.

So let's leave this issue open, and close the others as duplicates. The idea is to write a script that would fix all the docblocks so that they have a blank line between the @param section and the @return. Or, even simpler, so that there is a blank line before the @return in each docblock.

amateescu’s picture

StatusFileSize
new42.71 KB

How about some good old find/up arrow/enter for a start? :)

Not marking CNR because i don't want to stress the test bots with this patch.

jhodgdon’s picture

The patch looks reasonable (at least at first skim) for includes/*.inc, but we actually do want a script, and there are more files in modules/* for instance that need this change.

Does the Coder module have a test/fix for this? If so, maybe we can leverage that?

alexander allen’s picture

How about a regex in Zend Studio file search?

jhodgdon’s picture

Does Zend Studio do search *and replace* with a regexp? I don't know if that's acceptable anyway. The objective would be to have something anyone can run, and not everyone has Zend.

How about a PHP or shell script, or better yet, a patch to the Coder/Coder Update module?

jhodgdon’s picture

Status: Active » Closed (duplicate)

We are doing a doc sprint to fix this up along with some other docs problems. So closing this as a duplicate of
#1310084: [meta] API documentation cleanup sprint