Task #1280

Tag all classes as @internal - except the released API

Added by Robert Lemke about 11 years ago. Updated almost 9 years ago.

Status:
Resolved
Priority:
Must have
Assignee:
Category:
- Documentation -
Start date:
2008-08-14
Due date:
2008-09-15
% Done:

100%

Sprint:
PHP Version:
Has patch:
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

Related to TYPO3.Flow - Task #3883: Mark all public API with @api tags Resolved 2009-07-13

Associated revisions

Revision 3aa91a19 (diff)
Added by Robert Lemke over 10 years ago

  • 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 about 11 years ago

  • Assignee set to Robert Lemke

#2 Updated by Robert Lemke over 10 years ago

  • Target version set to 1.0 alpha 1

#3 Updated by Robert Lemke over 10 years ago

  • Status changed from New to Accepted

#4 Updated by Robert Lemke over 10 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 over 10 years ago

  • Status changed from Accepted to Resolved
  • % Done changed from 0 to 100

Applied in changeset r2293.

Also available in: Atom PDF