Problem/Motivation

https://www.drupal.org/coding-standards/docs is missing the @internal tag. I've noticed that we're starting to use this tag in several different core issue.

Proposed resolution

Discuss & document how to standardize this.

Comments

legovaer created an issue. See original summary.

legovaer’s picture

legovaer
he/him
Primary language Dutch
Location Duffel
commented

A first suggestion:

<?php
/**
  * @internal 
  *   Should not be used in user code. Use \Drupal\Core\... instead.
  */
?>
legovaer’s picture

legovaer
he/him
Primary language Dutch
Location Duffel
commented
Category: Bug report » Task
catch’s picture

catch
he/him
Primary language English
commented

We should document that the specific location of filenames for procedural code, and the location of any given function in a specific file, is @internal.

Coming from #7269: [meta] Add .php extension to PHP files but just moving something from bootstrap.inc to common.inc or vice-versa we should be able to do.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Active » Closed (duplicate)

This is being discussed in #2550249: [meta] Document @internal APIs both explicitly in phpdoc and implicitly in d.o documentation and I do not think we need a separate issue for it.