Problem/Motivation

Currently the module has been using the Drupalism regarding API that are not well spelled out.

Steps to reproduce

Proposed resolution

Label classes/methods that are API(expected to be called outside the module) as @api
Any class or method not labeled @api will be subject to breaking changes without BC.

Clarifying: if an entire class is marked @api all methods on the class are also API spec.

This will also place us in a spot that eventually we could allow PHPStan to help implementers become aware of non-api usage.

Remaining tasks

User interface changes

API changes

None, only clarification of what is and is not already API.

Data model changes

Issue fork vault-3485518

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

Comments

cmlara created an issue. See original summary.

  • cmlara committed 5d5edb25 on 3.x
    Issue #3485518:  Explicitly annotate api
    
cmlara’s picture

Status: Active » Fixed

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.