Add missing type hinting to Syslog module docblocks [#1816858]

This is a sub-issue of #1800046: [META] Add missing type hinting to core docblocks, fix Drupal.Commenting.FunctionComment.Missing* focused on correctly adding @param and @return type hinting to the Syslog module.

Documentation patches that include type hinting are time consuming to both review and commit because one must dig into the actual code to confirm that the type hints are both correct and complete. Hence, please be patient and try to limit type hint patches to covering only a limited number of docblocks (20-25 as a guess).

Related sprint issues:

	Sprint Topic	Sub Issue
	#1518116: [meta] Make Core pass Coder Review	#1533392: Make syslog module pass Coder Review
	#1310084: [meta] API documentation cleanup sprint	#1368872: Clean up API docs for syslog
	#500866: [META] remove t() from assert message	#1797516: Remove t() from assertion messages in tests for the syslog module

Comment	File	Size	Author
#3	1816858-03.patch	495 bytes	bleen
#3
#1	1816858.patch	384 bytes	bleen
#1

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Comment #1

bleen CreditAttribution: bleen commented 20 October 2012 at 03:54

Status:

Active

» Needs review

File	Size
1816858.patch	384 bytes

It doesn't appear that there are any docblocks in the syslog module that need work. The attached patch fixes the smallest whitespace issue in the world.

Comment #2

Lars Toomre CreditAttribution: Lars Toomre commented 21 October 2012 at 01:43

Status:

Needs review

» Needs work

@bleen18 Thanks for this really small patch.

Looking at the code with the patch applied, I noticed that there is no explanation for the return statement in that same docblock. Could you add that here? I would be happy to RTBC after that is done.

The only other problem I saw with this module was an in-line comment in testSettings() at the end of the line. I do not think we should correct that problem here since this is a documentation patch. It does seem silly, though too, to create another small patch just to change the positioning of an inline comment to conform with our coding standards.