Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 0 additions & 15 deletions contributor_docs/contributing_to_the_p5js_reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 0 additions & 1 deletion src/accessibility/color_namer.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
* @module Environment
* @submodule Environment
* @for p5
* @requires core
*/

import color_conversion from '../color/color_conversion';
Expand Down
1 change: 0 additions & 1 deletion src/accessibility/describe.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
* @module Environment
* @submodule Environment
* @for p5
* @requires core
*/

function describe(p5, fn){
Expand Down
1 change: 0 additions & 1 deletion src/accessibility/gridOutput.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
* @module Environment
* @submodule Environment
* @for p5
* @requires core
*/

function gridOutput(p5, fn){
Expand Down
1 change: 0 additions & 1 deletion src/accessibility/outputs.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
* @module Environment
* @submodule Environment
* @for p5
* @requires core
*/

function outputs(p5, fn){
Expand Down
1 change: 0 additions & 1 deletion src/accessibility/textOutput.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
* @module Environment
* @submodule Environment
* @for p5
* @requires core
*/

function textOutput(p5, fn){
Expand Down
1 change: 0 additions & 1 deletion src/color/color_conversion.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
* @module Color
* @submodule Color Conversion
* @for p5
* @requires core
*/

/**
Expand Down
2 changes: 0 additions & 2 deletions src/color/creating_reading.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
* @module Color
* @submodule Creating & Reading
* @for p5
* @requires core
* @requires constants
*/

import { Color } from './p5.Color';
Expand Down
2 changes: 0 additions & 2 deletions src/color/p5.Color.js
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand Down
2 changes: 0 additions & 2 deletions src/color/setting.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
* @module Color
* @submodule Setting
* @for p5
* @requires core
* @requires constants
*/

import * as constants from '../core/constants';
Expand Down
2 changes: 0 additions & 2 deletions src/core/environment.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
* @module Environment
* @submodule Environment
* @for p5
* @requires core
* @requires constants
*/

import * as C from './constants';
Expand Down
1 change: 0 additions & 1 deletion src/core/friendly_errors/fes_core.js
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 0 additions & 1 deletion src/core/friendly_errors/file_errors.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
/**
* @for p5
* @requires core
*/
import { translator } from '../internationalization';

Expand Down
1 change: 0 additions & 1 deletion src/core/friendly_errors/param_validator.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
/**
* @for p5
* @requires core
*/
import * as constants from '../constants.js';
import { z } from 'zod/v4';
Expand Down
1 change: 0 additions & 1 deletion src/core/friendly_errors/stacktrace.js
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 0 additions & 1 deletion src/core/helpers.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
/**
* @requires constants
*/

import * as constants from './constants';
Expand Down
1 change: 0 additions & 1 deletion src/core/legacy.js
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 0 additions & 1 deletion src/core/main.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
* @module Structure
* @submodule Structure
* @for p5
* @requires constants
*/

import * as constants from './constants';
Expand Down
1 change: 0 additions & 1 deletion src/core/structure.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
* @module Structure
* @submodule Structure
* @for p5
* @requires core
*/

function structure(p5, fn){
Expand Down
2 changes: 0 additions & 2 deletions src/core/transform.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
* @module Transform
* @submodule Transform
* @for p5
* @requires core
* @requires constants
*/

function transform(p5, fn){
Expand Down
1 change: 0 additions & 1 deletion src/data/local_storage.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
/**
* @module Data
* @submodule LocalStorage
* @requires core
*
* This module defines the p5 methods for working with local storage
*/
Expand Down
1 change: 0 additions & 1 deletion src/dom/dom.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@
* @module DOM
* @submodule DOM
* @for p5
* @requires p5
*/

import { Element } from './p5.Element';
Expand Down
1 change: 0 additions & 1 deletion src/events/acceleration.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
* @module Events
* @submodule Acceleration
* @for p5
* @requires core
* @main Events
*/

Expand Down
1 change: 0 additions & 1 deletion src/events/keyboard.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
* @module Events
* @submodule Keyboard
* @for p5
* @requires core
*/
export function isCode(input) {
const leftRightKeys = [
Expand Down
2 changes: 0 additions & 2 deletions src/events/pointer.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
* @module Events
* @submodule Pointer
* @for p5
* @requires core
* @requires constants
*/

function pointer(p5, fn, lifecycles){
Expand Down
1 change: 0 additions & 1 deletion src/image/image.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
* @module Image
* @submodule Image
* @for p5
* @requires core
*/

/**
Expand Down
1 change: 0 additions & 1 deletion src/image/loading_displaying.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
* @module Image
* @submodule Loading & Displaying
* @for p5
* @requires core
*/

import canvas from '../core/helpers';
Expand Down
3 changes: 0 additions & 3 deletions src/image/p5.Image.js
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
/**
* @module Image
* @submodule Image
* @requires core
* @requires constants
* @requires filters
*/

/**
Expand Down
1 change: 0 additions & 1 deletion src/image/pixels.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
* @module Image
* @submodule Pixels
* @for p5
* @requires core
*/

import Filters from './filters';
Expand Down
1 change: 0 additions & 1 deletion src/io/files.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
* @module IO
* @submodule Input
* @for p5
* @requires core
*/

import { Renderer } from '../core/p5.Renderer';
Expand Down
1 change: 0 additions & 1 deletion src/io/p5.Table.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
/**
* @module IO
* @submodule Table
* @requires core
*/

import { stringify } from './csv';
Expand Down
1 change: 0 additions & 1 deletion src/io/p5.TableRow.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
/**
* @module IO
* @submodule Table
* @requires core
*/

class TableRow {
Expand Down
1 change: 0 additions & 1 deletion src/io/p5.XML.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
/**
* @module IO
* @submodule Input
* @requires core
*/

class XML {
Expand Down
1 change: 0 additions & 1 deletion src/math/Matrices/MatrixNumjs.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion src/math/calculation.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
* @module Math
* @submodule Calculation
* @for p5
* @requires core
*/

function calculation(p5, fn){
Expand Down
1 change: 0 additions & 1 deletion src/math/math.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
/**
* @module Math
* @for p5
* @requires core
*/

function math(p5, fn) {
Expand Down
1 change: 0 additions & 1 deletion src/math/noise.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
* @module Math
* @submodule Noise
* @for p5
* @requires core
*/
function noise(p5, fn){
const PERLIN_YWRAPB = 4;
Expand Down
1 change: 0 additions & 1 deletion src/math/p5.Matrix.js
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 0 additions & 1 deletion src/math/p5.Vector.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
/**
* @module Math
* @requires constants
*/

import * as constants from '../core/constants';
Expand Down
1 change: 0 additions & 1 deletion src/math/random.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
* @module Math
* @submodule Random
* @for p5
* @requires core
*/

function random(p5, fn){
Expand Down
2 changes: 0 additions & 2 deletions src/math/trigonometry.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
* @module Math
* @submodule Trigonometry
* @for p5
* @requires core
* @requires constants
*/

import * as constants from '../core/constants';
Expand Down
2 changes: 0 additions & 2 deletions src/shape/2d_primitives.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
* @module Shape
* @submodule 2D Primitives
* @for p5
* @requires core
* @requires constants
*/

import * as constants from '../core/constants';
Expand Down
2 changes: 0 additions & 2 deletions src/shape/attributes.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
* @module Shape
* @submodule Attributes
* @for p5
* @requires core
* @requires constants
*/

import * as constants from '../core/constants';
Expand Down
1 change: 0 additions & 1 deletion src/shape/curves.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
* @module Shape
* @submodule Curves
* @for p5
* @requires core
*/

function curves(p5, fn){
Expand Down
2 changes: 0 additions & 2 deletions src/shape/custom_shapes.js
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 0 additions & 2 deletions src/shape/vertex.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
* @module Shape
* @submodule Custom Shapes
* @for p5
* @requires core
* @requires constants
*/

function vertex(p5, fn){
Expand Down
1 change: 0 additions & 1 deletion src/strands/p5.strands.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
* @module 3D
* @submodule p5.strands
* @for p5
* @requires core
*/

import { transpileStrandsToJS } from "./strands_transpiler";
Expand Down
Loading