diff --git a/contributor_docs/contributing_to_the_p5js_reference.md b/contributor_docs/contributing_to_the_p5js_reference.md index 0bd05a209d..e4399211a6 100644 --- 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 - */ -``` #### 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 index bfe1c96a58..9a9225c2eb 100644 --- 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 index 4ede8cef65..8310fda3bf 100644 --- 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 index 21b900b24e..fc3e67ed78 100644 --- 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 index 1443d9004c..5fd5183016 100644 --- 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 index 971718fc26..46baa56071 100644 --- 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 index 850d24918b..11823f077e 100644 --- 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 index a6aa934dc1..7690104406 100644 --- 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 index e3724bf4ff..29b5996fb3 100644 --- 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 index a8e8d0b1b3..04ddb8372f 100644 --- 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 index 6fffe81973..c27683cf31 100644 --- 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 index 8962745918..f86389e12c 100644 --- 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 index 8f212c8355..75b8462b72 100644 --- 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 index 5fa4e73151..4e9f912773 100644 --- 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 index 1777abac41..1c60713f9f 100644 --- 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 index 0bc0ddbe3d..9f31e78d8a 100644 --- 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 index bf05901333..6253b8894e 100644 --- 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 index 4ce9d91c55..7f8af440a2 100644 --- 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 index 19c96c2156..6d17882f27 100644 --- 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 index 0b8eb95a5b..4ff359d5a9 100644 --- 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 index f625618c95..505b500d61 100644 --- 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 index 9f1dcb14c7..e975740ca0 100644 --- 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 index 7750f6099b..0d1557d5c1 100644 --- 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 index eee2195f4d..0e51b0632c 100644 --- 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 index b14b7c25d4..3fc8560302 100644 --- 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 index 707892fe42..2296f5a414 100644 --- 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 index 28149c4412..81f18b9a64 100644 --- 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 index 80e5781524..431d618e77 100644 --- 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 index c1b7b4abe6..50e315166a 100644 --- 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 index 41af75877e..013f4803d5 100644 --- 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 index 691742a462..47f5ccf273 100644 --- 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 index 03e59936ad..59e5d028ac 100644 --- 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 index e4e010f839..ba1cba3b9c 100644 --- 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 index 8ee35a7ee8..22ccf2e875 100644 --- 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 index a97e549854..82b788e788 100644 --- 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 index 9e513a7c36..1c4a7e0fa9 100644 --- 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 index 0105615fc8..16c08c484c 100644 --- 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 index b6488f76d0..8923bb420c 100644 --- 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 index c9cf317548..2f9682ad39 100644 --- 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 index 984094fc3d..cd56ed5530 100644 --- 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 index d2c5491b7d..0ca07bf84a 100644 --- 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 index aa246664b8..d5a57f1cb8 100644 --- 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 index 812159267f..ab5ec21a01 100644 --- 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 index 5f5e278811..7e2b49a2a1 100644 --- 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 index f287a4823e..0840d3d357 100644 --- 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 index fbe46e0cba..0f41a6c043 100644 --- 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 index d8c839847e..8360dd2468 100644 --- 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 index 909609ef0c..079294b64a 100644 --- a/src/type/textCore.js +++ b/src/type/textCore.js @@ -1,6 +1,5 @@ /** * @module Typography - * @requires core */ import { Renderer } from '../core/p5.Renderer'; diff --git a/src/utilities/conversion.js b/src/utilities/conversion.js index 7ebe26ba8f..5727735156 100644 --- a/src/utilities/conversion.js +++ b/src/utilities/conversion.js @@ -2,7 +2,6 @@ * @module Data * @submodule Conversion * @for p5 - * @requires core */ function conversion(p5, fn){ diff --git a/src/utilities/time_date.js b/src/utilities/time_date.js index ab240ee058..029b36a7cc 100644 --- a/src/utilities/time_date.js +++ b/src/utilities/time_date.js @@ -2,7 +2,6 @@ * @module IO * @submodule Time & Date * @for p5 - * @requires core */ function timeDate(p5, fn){ diff --git a/src/utilities/utility_functions.js b/src/utilities/utility_functions.js index 4929522642..11964db774 100644 --- a/src/utilities/utility_functions.js +++ b/src/utilities/utility_functions.js @@ -2,7 +2,6 @@ * @module Data * @submodule Utility Functions * @for p5 - * @requires core */ function utilityFunctions(p5, fn){ diff --git a/src/webgl/3d_primitives.js b/src/webgl/3d_primitives.js index cd6cccc893..5eb78db6c6 100644 --- a/src/webgl/3d_primitives.js +++ b/src/webgl/3d_primitives.js @@ -2,8 +2,6 @@ * @module Shape * @submodule 3D Primitives * @for p5 - * @requires core - * @requires p5.Geometry */ import * as constants from '../core/constants'; diff --git a/src/webgl/interaction.js b/src/webgl/interaction.js index ef5beb665a..e65f3a2729 100644 --- a/src/webgl/interaction.js +++ b/src/webgl/interaction.js @@ -2,7 +2,6 @@ * @module 3D * @submodule Interaction * @for p5 - * @requires core */ import * as constants from '../core/constants'; diff --git a/src/webgl/light.js b/src/webgl/light.js index 72938bc291..483b9a53b7 100644 --- a/src/webgl/light.js +++ b/src/webgl/light.js @@ -2,7 +2,6 @@ * @module 3D * @submodule Lights * @for p5 - * @requires core */ import { Renderer3D } from '../core/p5.Renderer3D'; diff --git a/src/webgl/loading.js b/src/webgl/loading.js index e1d726389c..51eef5b09d 100755 --- a/src/webgl/loading.js +++ b/src/webgl/loading.js @@ -2,8 +2,6 @@ * @module Shape * @submodule 3D Models * @for p5 - * @requires core - * @requires p5.Geometry */ import { Geometry } from './p5.Geometry'; diff --git a/src/webgl/material.js b/src/webgl/material.js index 624f9eaaf3..000a12fb7c 100644 --- a/src/webgl/material.js +++ b/src/webgl/material.js @@ -2,7 +2,6 @@ * @module 3D * @submodule Material * @for p5 - * @requires core */ import * as constants from "../core/constants"; diff --git a/src/webgl/p5.Camera.js b/src/webgl/p5.Camera.js index 5dcca97a20..01fa642fc2 100644 --- a/src/webgl/p5.Camera.js +++ b/src/webgl/p5.Camera.js @@ -1,7 +1,6 @@ /** * @module 3D * @submodule Camera - * @requires core */ import { Matrix } from '../math/p5.Matrix'; diff --git a/src/webgl/p5.Framebuffer.js b/src/webgl/p5.Framebuffer.js index 29ef58bc3f..fc04f83792 100644 --- a/src/webgl/p5.Framebuffer.js +++ b/src/webgl/p5.Framebuffer.js @@ -1,6 +1,5 @@ /** * @module Rendering - * @requires constants */ import * as constants from '../core/constants'; diff --git a/src/webgl/p5.Geometry.js b/src/webgl/p5.Geometry.js index a2c8992885..2c53833004 100644 --- a/src/webgl/p5.Geometry.js +++ b/src/webgl/p5.Geometry.js @@ -2,8 +2,6 @@ * @module Shape * @submodule 3D Primitives * @for p5 - * @requires core - * @requires p5.Geometry */ //some of the functions are adjusted from Three.js(http://threejs.org) diff --git a/src/webgl/p5.Shader.js b/src/webgl/p5.Shader.js index a881825948..82a4f603ec 100644 --- a/src/webgl/p5.Shader.js +++ b/src/webgl/p5.Shader.js @@ -3,7 +3,6 @@ * @module 3D * @submodule Material * @for p5 - * @requires core */ const TypedArray = Object.getPrototypeOf(Uint8Array); diff --git a/src/webgl/p5.Texture.js b/src/webgl/p5.Texture.js index 7441ae5139..3c12e6ed69 100644 --- a/src/webgl/p5.Texture.js +++ b/src/webgl/p5.Texture.js @@ -3,7 +3,6 @@ * @module 3D * @submodule Material * @for p5 - * @requires core */ import * as constants from '../core/constants';