Task #1280
Tag all classes as @internal - except the released API
| Status: | Resolved | Start date: | 2008-08-14 | |
|---|---|---|---|---|
| Priority: | Must have | Due date: | 2008-09-15 | |
| Assigned To: | Robert Lemke | % Done: | 100% |
|
| Category: | - Documentation - | |||
| Target version: | TYPO3 Flow Base Distribution - 1.0 alpha 1 | |||
| Sprint: | Has patch: | |||
| PHP Version: | Complexity: |
Description
Starting with the first release of FLOW3 we need to communicate which APIs are safe for use in third-party packages and which ones you should better avoid. This should be done through the API documentation - all classes and methods which are documented there, may be used.
In order to create that source of information we need to initially tag all classes as @internal and then remove the annotation from all classes we want to release as public API.
Related issues
Associated revisions
- FLOW3: Marked all methods as @internal except those which are considered part of the official API. Resolves #1280
- TYPO3CR: Fixed two tests of the Storage\PDO\Search testcase.
History
#1 Updated by Robert Lemke almost 7 years ago
- Assigned To set to Robert Lemke
#2 Updated by Robert Lemke about 6 years ago
- Target version set to 1.0 alpha 1
#3 Updated by Robert Lemke about 6 years ago
- Status changed from New to Accepted
#4 Updated by Robert Lemke about 6 years ago
Here's the script I used to add @internal annotations to all function doc comments:
The shell command line
find ./Packages/ -name '*.php' -exec php add-internal-annotations.php {} \;
The PHP script
<?php
$file = file_get_contents($argv[1]);
$pattern = '/ \* @internal
/';
$replacement = '';
$file = preg_replace($pattern, $replacement, $file);
$pattern = '/ \*\/
([public|protected|private|final|abstract]+\s*)function/';
$replacement = ' * @internal
*/
$1function';
$file = preg_replace($pattern, $replacement, $file);
file_put_contents($argv[1], $file);
?>
#5 Updated by Robert Lemke about 6 years ago
- Status changed from Accepted to Resolved
- % Done changed from 0 to 100
Applied in changeset r2293.