Task #3883

Mark all public API with @api tags

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

Status:
Resolved
Priority:
Must have
Category:
- Documentation -
Start date:
2009-07-13
Due date:
% Done:

100%

Sprint:
PHP Version:
Has patch:
Complexity:

Description

The blacklisting approach with @internal tags is too error-prone and tedious to implement. We should go for a white list approach instead and mark all functions / methods which are part of the public (supported) API with an @api tag.


Related issues

Related to TYPO3.Flow - Task #1280: Tag all classes as @internal - except the released API Resolved 2008-08-14 2008-09-15

Associated revisions

Revision b22b5d93 (diff)
Added by Karsten Dambekalns about 10 years ago

[TASK] FLOW3: moved from @internal to @api, resolves #3883

Revision 452bd856 (diff)
Added by Karsten Dambekalns about 10 years ago

[TASK] FLOW3: fixed some @internal vs @api remnants, relates to #3883

History

#1 Updated by Karsten Dambekalns about 10 years ago

  • Status changed from New to Accepted
  • Assignee set to Karsten Dambekalns

Today I taught PHP_UML to deal with the @api annotation as expected. Afterwards I started to go over the @internal annotations again to remove them and add @api on the inverse.

#2 Updated by Karsten Dambekalns about 10 years ago

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

Applied in changeset r2794.

Also available in: Atom PDF