Story #17855
closedphp-docs for all hooks
0%
Description
Currently there is no common documentation for all hooks in the core.
As they are quite important to extension programmers it would be nice to have a place where all information about hooks is collected.
All hooks should get marked with php-doc comments and some unique identifier.
There should be a link to a wiki page for each hook where extension programmers and other volunteers can add "special" information about the hooks and about extensions which utilize those.
Proposed example for php-doc for an hook:
/**
* @hook renderListHeader: Allows to change the contents of columns/cells of the Web>List table headers
* @date 2007-11-20
* @request Bernhard Kraft <krafbt@kraftb.at>
* @usage Above each listed table in Web>List a header row is shown. Containing the labels of all shown fields and additional icons to create new records for this table or perform special clipboard tasks like mark and copy all listed records to clipboard, etc.
*/
@hook ... Method name: Hook description
@date ... Date when added
@request ... Developer who requested the hook
@usage ... Minimal explanation of how the hook gets used
@Karol Linkiewicz ... Link to wiki.typo3.org unique for each hook
RFC ?
(issue imported from #M6841)
Updated by Alexander Opitz over 10 years ago
- Category set to Documentation
- Assignee deleted (
Bernhard Kraft) - Target version deleted (
0) - Is Regression set to No
Updated by Mathias Schreiber over 9 years ago
- Tracker changed from Bug to Story
- Target version set to 7 LTS
- Translation missing: en.field_remaining_hours set to 0.0
Updated by Christian Kuhn over 6 years ago
- Status changed from Accepted to Closed
this won't happen anytime soon. hooks are so generic that it is hard to create good documentation from them. i'm closing this issue for now, auto-documentation would be part of a general 'new-hook-concept' approach.