simplenews.module currently starts like this:
/**
* @defgroup simplenews
* Enable nodes to be used as newsletter, manage subscriptions and sent
* email newsletter to subscribers.
*/
/**
* @file
* Simplenews node handling, sent email, newsletter block and general hooks
*
* @ingroup simplenews
* @todo Where possible build re-usable functions wrapped around database calls.
* @todo Consider context support for t():
* @todo Coding standards: type hinting
* @todo Implement hook_requirements()?;
* @todo Separate token function into simplenews.tokens.inc
* @todo Consider using hook_hook_info() to move hooks out of .module.
*/
The initial @defgroup is not necessary. As for the @todo's:
- Check if there are remaining direct db_* uses in non API functions like forms, page callbacks and hook implementations. Check if we can move them into API functions.
- Haven't seen a need for t() context, remove that
- Coding standards have been cleaned up, type hinting doesn't make much sense until we have entity classes, remove.
- I don't know what we could possibly check in hook_requirements(), remove.
- Moving the token hooks makese sense.
- hook_hook_info() doesn't help us, we can only do it for our own hooks. Remove.
Comment | File | Size | Author |
---|---|---|---|
#5 | simplenews-1546678-5.patch | 12.92 KB | corvus_ch |
#2 | simplenews-1546678-2.patch | 12.92 KB | corvus_ch |
Comments
Comment #1
BerdirOh, looks like the
blocks with links get messed up...
Comment #2
corvus_ch CreditAttribution: corvus_ch commentedComment #3
BerdirComment #4
BerdirYou can delete the whole block here.
And this as well. We are removing the defgroup from above, and adding a @ingroup to a @file docblock makes no sense anyway.
Comment #5
corvus_ch CreditAttribution: corvus_ch commentedComment #6
BerdirComment #8
Berdir#5: simplenews-1546678-5.patch queued for re-testing.
Comment #9
BerdirCommited and pushed.
Comment #10.0
(not verified) CreditAttribution: commentedUpdated issue summary.