Merge pull request #8713 from nbogie/nb-remove-requires-jsdoc

davepagurek · web-flow · commit 9498619e7b31 · 2026-04-14T19:49:36.000-04:00
remove unused `@requires` from all jsdoc
diff --git a/contributor_docs/contributing_to_the_p5js_reference.md b/contributor_docs/contributing_to_the_p5js_reference.md
@@ -977,21 +977,6 @@ Example:
    */
 ```
 
-#### The @requires tag
-
-The `@requires` tag defines the required imported modules that the current module depends on.
-
-Example of `@for` and `@requires`
-
-```js
-/**
- * @module Color
- * @submodule Creating & Reading
- * @for p5
- * @requires core
- * @requires constants
- */
-```
 #### <a id="beta"></a>The @beta tag - marking experimental API features
 
 This tag is used to mark that a feature is experimental and that its details may change or it may be removed.  A warning will be presented explaining this on the reference page.
diff --git a/src/accessibility/color_namer.js b/src/accessibility/color_namer.js
@@ -2,7 +2,6 @@
  * @module Environment
  * @submodule Environment
  * @for p5
- * @requires core
  */
 
 import color_conversion from '../color/color_conversion';
diff --git a/src/accessibility/describe.js b/src/accessibility/describe.js
@@ -2,7 +2,6 @@
  * @module Environment
  * @submodule Environment
  * @for p5
- * @requires core
  */
 
 function describe(p5, fn){
diff --git a/src/accessibility/gridOutput.js b/src/accessibility/gridOutput.js
@@ -2,7 +2,6 @@
  * @module Environment
  * @submodule Environment
  * @for p5
- * @requires core
  */
 
 function gridOutput(p5, fn){
diff --git a/src/accessibility/outputs.js b/src/accessibility/outputs.js
@@ -2,7 +2,6 @@
  * @module Environment
  * @submodule Environment
  * @for p5
- * @requires core
  */
 
 function outputs(p5, fn){
diff --git a/src/accessibility/textOutput.js b/src/accessibility/textOutput.js
@@ -2,7 +2,6 @@
  * @module Environment
  * @submodule Environment
  * @for p5
- * @requires core
  */
 
 function textOutput(p5, fn){
diff --git a/src/color/color_conversion.js b/src/color/color_conversion.js
@@ -2,7 +2,6 @@
  * @module Color
  * @submodule Color Conversion
  * @for p5
- * @requires core
  */
 
 /**
diff --git a/src/color/creating_reading.js b/src/color/creating_reading.js
@@ -2,8 +2,6 @@
  * @module Color
  * @submodule Creating & Reading
  * @for p5
- * @requires core
- * @requires constants
  */
 
 import { Color } from './p5.Color';
diff --git a/src/color/p5.Color.js b/src/color/p5.Color.js
@@ -2,8 +2,6 @@
  * @module Color
  * @submodule Creating & Reading
  * @for p5
- * @requires core
- * @requires color_conversion
  */
 
 import { RGB, RGBHDR, HSL, HSB, HWB, LAB, LCH, OKLAB, OKLCH } from './creating_reading';
diff --git a/src/color/setting.js b/src/color/setting.js
@@ -2,8 +2,6 @@
  * @module Color
  * @submodule Setting
  * @for p5
- * @requires core
- * @requires constants
  */
 
 import * as constants from '../core/constants';
diff --git a/src/core/environment.js b/src/core/environment.js
@@ -2,8 +2,6 @@
  * @module Environment
  * @submodule Environment
  * @for p5
- * @requires core
- * @requires constants
  */
 
 import * as C from './constants';
diff --git a/src/core/friendly_errors/fes_core.js b/src/core/friendly_errors/fes_core.js
@@ -1,6 +1,5 @@
 /**
  * @for p5
- * @requires core
  *
  * This is the main file for the Friendly Error System (FES), containing
  * the core as well as miscellaneous functionality of the FES. Here is a
diff --git a/src/core/friendly_errors/file_errors.js b/src/core/friendly_errors/file_errors.js
@@ -1,6 +1,5 @@
 /**
  * @for p5
- * @requires core
  */
 import { translator } from '../internationalization';
 
diff --git a/src/core/friendly_errors/param_validator.js b/src/core/friendly_errors/param_validator.js
@@ -1,6 +1,5 @@
 /**
  * @for p5
- * @requires core
  */
 import * as constants from '../constants.js';
 import { z } from 'zod/v4';
diff --git a/src/core/friendly_errors/stacktrace.js b/src/core/friendly_errors/stacktrace.js
@@ -1,6 +1,5 @@
 /**
  * @for p5
- * @requires core
  */
 // Borrow from stacktracejs https://github.com/stacktracejs/stacktrace.js with
 // minor modifications. The license for the same and the code is included below
diff --git a/src/core/helpers.js b/src/core/helpers.js
@@ -1,5 +1,4 @@
 /**
- * @requires constants
  */
 
 import * as constants from './constants';
diff --git a/src/core/legacy.js b/src/core/legacy.js
@@ -1,6 +1,5 @@
 /**
  * @for p5
- * @requires core
  * These are functions that are part of the Processing API but are not part of
  * the p5.js API. In some cases they have a new name, in others, they are
  * removed completely. Not all unsupported Processing functions are listed here
diff --git a/src/core/main.js b/src/core/main.js
@@ -2,7 +2,6 @@
  * @module Structure
  * @submodule Structure
  * @for p5
- * @requires constants
  */
 
 import * as constants from './constants';
diff --git a/src/core/structure.js b/src/core/structure.js
@@ -2,7 +2,6 @@
  * @module Structure
  * @submodule Structure
  * @for p5
- * @requires core
  */
 
 function structure(p5, fn){
diff --git a/src/core/transform.js b/src/core/transform.js
@@ -2,8 +2,6 @@
  * @module Transform
  * @submodule Transform
  * @for p5
- * @requires core
- * @requires constants
  */
 
 function transform(p5, fn){
diff --git a/src/data/local_storage.js b/src/data/local_storage.js
@@ -1,7 +1,6 @@
 /**
  * @module Data
  * @submodule LocalStorage
- * @requires core
  *
  * This module defines the p5 methods for working with local storage
  */
diff --git a/src/dom/dom.js b/src/dom/dom.js
@@ -13,7 +13,6 @@
  * @module DOM
  * @submodule DOM
  * @for p5
- * @requires p5
  */
 
 import { Element } from './p5.Element';
diff --git a/src/events/acceleration.js b/src/events/acceleration.js
@@ -2,7 +2,6 @@
  * @module Events
  * @submodule Acceleration
  * @for p5
- * @requires core
  * @main Events
  */
 
diff --git a/src/events/keyboard.js b/src/events/keyboard.js
@@ -2,7 +2,6 @@
  * @module Events
  * @submodule Keyboard
  * @for p5
- * @requires core
  */
 export function isCode(input) {
   const leftRightKeys = [
diff --git a/src/events/pointer.js b/src/events/pointer.js
@@ -2,8 +2,6 @@
  * @module Events
  * @submodule Pointer
  * @for p5
- * @requires core
- * @requires constants
  */
 
 function pointer(p5, fn, lifecycles){
diff --git a/src/image/image.js b/src/image/image.js
@@ -2,7 +2,6 @@
  * @module Image
  * @submodule Image
  * @for p5
- * @requires core
  */
 
 /**
diff --git a/src/image/loading_displaying.js b/src/image/loading_displaying.js
@@ -2,7 +2,6 @@
  * @module Image
  * @submodule Loading & Displaying
  * @for p5
- * @requires core
  */
 
 import canvas from '../core/helpers';
diff --git a/src/image/p5.Image.js b/src/image/p5.Image.js
@@ -1,9 +1,6 @@
 /**
  * @module Image
  * @submodule Image
- * @requires core
- * @requires constants
- * @requires filters
  */
 
 /**
diff --git a/src/image/pixels.js b/src/image/pixels.js
@@ -2,7 +2,6 @@
  * @module Image
  * @submodule Pixels
  * @for p5
- * @requires core
  */
 
 import Filters from './filters';
diff --git a/src/io/files.js b/src/io/files.js
@@ -2,7 +2,6 @@
  * @module IO
  * @submodule Input
  * @for p5
- * @requires core
  */
 
 import { Renderer } from '../core/p5.Renderer';
diff --git a/src/io/p5.Table.js b/src/io/p5.Table.js
@@ -1,7 +1,6 @@
 /**
  * @module IO
  * @submodule Table
- * @requires core
  */
 
 import { stringify } from './csv';
diff --git a/src/io/p5.TableRow.js b/src/io/p5.TableRow.js
@@ -1,7 +1,6 @@
 /**
  * @module IO
  * @submodule Table
- * @requires core
  */
 
 class TableRow {
diff --git a/src/io/p5.XML.js b/src/io/p5.XML.js
@@ -1,7 +1,6 @@
 /**
  * @module IO
  * @submodule Input
- * @requires core
  */
 
 class XML {
diff --git a/src/math/Matrices/MatrixNumjs.js b/src/math/Matrices/MatrixNumjs.js
@@ -3,7 +3,6 @@ import { Vector } from '../p5.Vector';
 import { MatrixInterface } from './MatrixInterface';
 
 /**
- * @requires constants
  * @todo see methods below needing further implementation.
  * future consideration: implement SIMD optimizations
  * when browser compatibility becomes available
diff --git a/src/math/calculation.js b/src/math/calculation.js
@@ -2,7 +2,6 @@
  * @module Math
  * @submodule Calculation
  * @for p5
- * @requires core
  */
 
 function calculation(p5, fn){
diff --git a/src/math/math.js b/src/math/math.js
@@ -1,7 +1,6 @@
 /**
  * @module Math
  * @for p5
- * @requires core
  */
 
 function math(p5, fn) {
diff --git a/src/math/noise.js b/src/math/noise.js
@@ -15,7 +15,6 @@
  * @module Math
  * @submodule Noise
  * @for p5
- * @requires core
  */
 function noise(p5, fn){
   const PERLIN_YWRAPB = 4;
diff --git a/src/math/p5.Matrix.js b/src/math/p5.Matrix.js
@@ -1,6 +1,5 @@
 /**
  * @module Math
- * @requires constants
  * @todo see methods below needing further implementation.
  * future consideration: implement SIMD optimizations
  * when browser compatibility becomes available
diff --git a/src/math/p5.Vector.js b/src/math/p5.Vector.js
@@ -1,6 +1,5 @@
 /**
  * @module Math
- * @requires constants
  */
 
 import * as constants from '../core/constants';
diff --git a/src/math/random.js b/src/math/random.js
@@ -2,7 +2,6 @@
  * @module Math
  * @submodule Random
  * @for p5
- * @requires core
  */
 
 function random(p5, fn){
diff --git a/src/math/trigonometry.js b/src/math/trigonometry.js
@@ -2,8 +2,6 @@
  * @module Math
  * @submodule Trigonometry
  * @for p5
- * @requires core
- * @requires constants
  */
 
 import * as constants from '../core/constants';
diff --git a/src/shape/2d_primitives.js b/src/shape/2d_primitives.js
@@ -2,8 +2,6 @@
  * @module Shape
  * @submodule 2D Primitives
  * @for p5
- * @requires core
- * @requires constants
  */
 
 import * as constants from '../core/constants';
diff --git a/src/shape/attributes.js b/src/shape/attributes.js
@@ -2,8 +2,6 @@
  * @module Shape
  * @submodule Attributes
  * @for p5
- * @requires core
- * @requires constants
  */
 
 import * as constants from '../core/constants';
diff --git a/src/shape/curves.js b/src/shape/curves.js
@@ -2,7 +2,6 @@
  * @module Shape
  * @submodule Curves
  * @for p5
- * @requires core
  */
 
 function curves(p5, fn){
diff --git a/src/shape/custom_shapes.js b/src/shape/custom_shapes.js
@@ -2,8 +2,6 @@
  * @module Shape
  * @submodule Custom Shapes
  * @for p5
- * @requires core
- * @requires constants
  */
 
 // REMINDER: remove .js extension (currently using it to run file locally)
diff --git a/src/shape/vertex.js b/src/shape/vertex.js
@@ -2,8 +2,6 @@
  * @module Shape
  * @submodule Custom Shapes
  * @for p5
- * @requires core
- * @requires constants
  */
 
 function vertex(p5, fn){
diff --git a/src/strands/p5.strands.js b/src/strands/p5.strands.js
@@ -2,7 +2,6 @@
  * @module 3D
  * @submodule p5.strands
  * @for p5
- * @requires core
  */
 
 import { transpileStrandsToJS } from "./strands_transpiler";
diff --git a/src/type/textCore.js b/src/type/textCore.js
diff --git a/src/utilities/conversion.js b/src/utilities/conversion.js
diff --git a/src/utilities/time_date.js b/src/utilities/time_date.js
diff --git a/src/utilities/utility_functions.js b/src/utilities/utility_functions.js
diff --git a/src/webgl/3d_primitives.js b/src/webgl/3d_primitives.js
diff --git a/src/webgl/interaction.js b/src/webgl/interaction.js
diff --git a/src/webgl/light.js b/src/webgl/light.js
diff --git a/src/webgl/loading.js b/src/webgl/loading.js
diff --git a/src/webgl/material.js b/src/webgl/material.js
diff --git a/src/webgl/p5.Camera.js b/src/webgl/p5.Camera.js
diff --git a/src/webgl/p5.Framebuffer.js b/src/webgl/p5.Framebuffer.js
diff --git a/src/webgl/p5.Geometry.js b/src/webgl/p5.Geometry.js
diff --git a/src/webgl/p5.Shader.js b/src/webgl/p5.Shader.js
diff --git a/src/webgl/p5.Texture.js b/src/webgl/p5.Texture.js
