The 2026 Drupal Business Survey is open. Your response will help shape the future of the Drupal business ecosystem.Many hooks are currently undocumented and some just don't exist (mailing_list hooks).
Additionally, add a few initial api doc groups like API, mail to group similar functions together.
| Comment | File | Size | Author |
|---|---|---|---|
| #2 | some_more_apidocs.patch | 27.66 KB | berdir |
| #1 | start_api_documentation.patch | 19.74 KB | berdir |
Comments
Comment #1
berdirStart of a better api documentation.
The patch contains mostly non-functional changes so it's easy to do partial updates here.
The patch adds:
- @mainpage docblock with a textual overview with links to more specific topics/groups
- @defgroup docblocks various topics like subscribers, newsletters, issues, mail spool, source and so on. All of them are actually still missing detailed documentation
- @ingroup for all function in simplenews.module for which it makes sense (pretty much all except hook implementations + a few irrelevant helper functions).
Functional changes (might want to commit them separately):
- While going through the functions, I noticed that our hook_locale() implementations hasn't been removed... done that
- Also renamed simplenews_update_sent_status() to simplenews_newsletter_update_sent_status()
The result of this patch can be seen live on http://api.worldempire.ch/api/simplenews
Comment #2
berdirAdded a few more ingroup statements.
Comment #3
berdirCommited, setting back to active for more documentation for the doc groups.
Comment #4
miro_dietikerPushing...