diff --git a/cocos/core/animation/animation-state.ts b/cocos/core/animation/animation-state.ts index 099fd875e9..2dc95add23 100644 --- a/cocos/core/animation/animation-state.ts +++ b/cocos/core/animation/animation-state.ts @@ -304,7 +304,7 @@ export class AnimationState extends Playable { /** * @en The iteration duration of this animation in seconds. (length) - * @zh 单次动画的持续时间,秒。 + * @zh 单次动画的持续时间,秒。(动画长度) * @readOnly */ public duration = 1; diff --git a/cocos/core/assets/sprite-frame.ts b/cocos/core/assets/sprite-frame.ts index 98cc343eb7..c3f23f35d4 100644 --- a/cocos/core/assets/sprite-frame.ts +++ b/cocos/core/assets/sprite-frame.ts @@ -230,7 +230,7 @@ export class SpriteFrame extends Asset { * Right border of the sprite. * * @zh - * sprite 的左边边框。 + * sprite 的右边边框。 */ get insetRight () { return this._capInsets[INSET_RIGHT]; diff --git a/cocos/core/components/component.ts b/cocos/core/components/component.ts index 8475fe1b87..43741e2632 100644 --- a/cocos/core/components/component.ts +++ b/cocos/core/components/component.ts @@ -454,7 +454,7 @@ class Component extends CCObject { * @en Schedules a callback function that runs only once, with a delay of 0 or larger. * @zh 调度一个只运行一次的回调函数,可以指定 0 让回调函数在下一帧立即执行或者在一定的延时之后执行。 * @method scheduleOnce - * @see [[cc.Node.schedule]] + * @see [[Node.schedule]] * @param {function} callback 回调函数。 * @param {Number} delay 第一次执行前等待的时间(延时执行)。 * @example @@ -472,8 +472,6 @@ class Component extends CCObject { /** * @en Unschedules a custom callback function. * @zh 取消调度一个自定义的回调函数。 - * @method unschedule - * @see [[cc.Node.schedule]] * @param {function} callback_fn 回调函数。 * @example * ```typescript diff --git a/cocos/core/components/ui-base/deprecated.ts b/cocos/core/components/ui-base/deprecated.ts new file mode 100644 index 0000000000..5e936e024c --- /dev/null +++ b/cocos/core/components/ui-base/deprecated.ts @@ -0,0 +1,15 @@ +/** + * @hidden + */ + +import { removeProperty } from '../../utils'; +import { UIComponent } from './ui-component'; + +removeProperty(UIComponent.prototype, 'UIComponent',[ + { + name: '_visibility', + }, + { + name: 'setVisibility', + }, +]); diff --git a/cocos/core/components/ui-base/index.ts b/cocos/core/components/ui-base/index.ts index f5913a10c2..162d09790c 100644 --- a/cocos/core/components/ui-base/index.ts +++ b/cocos/core/components/ui-base/index.ts @@ -30,4 +30,6 @@ export * from './canvas-component'; export * from './ui-component'; export * from './ui-render-component'; -export * from './ui-transfrom-component'; \ No newline at end of file +export * from './ui-transfrom-component'; + +import './deprecated'; diff --git a/cocos/core/components/ui-base/ui-component.ts b/cocos/core/components/ui-base/ui-component.ts index 3f65882f14..f6503e7109 100644 --- a/cocos/core/components/ui-base/ui-component.ts +++ b/cocos/core/components/ui-base/ui-component.ts @@ -72,7 +72,6 @@ export class UIComponent extends Component { } return this._screen.visibility; - // return this._visibility; } get _screen (){ @@ -82,7 +81,6 @@ export class UIComponent extends Component { @property protected _priority = 0; - // protected _visibility = -1; protected _followScreen: CanvasComponent | null = null; private _lastParent: INode | null = null; @@ -103,37 +101,12 @@ export class UIComponent extends Component { } } - /** - * @zh - * 渲染数据收集。每个渲染组件都由此自身决定是否渲染以及渲染状态的更新。 - * - * @param render 数据处理中转站。 - */ public updateAssembler(render: UI) { } - - /** - * @zh - * 后渲染数据收集。每个渲染组件都由此接口决定是否渲染以及渲染状态的更新。 - * 一般是在自身子节点 updateAssembler 执行完调用。 - * - * @param render 数据处理中转站。 - */ public postUpdateAssembler(render: UI) { } - /** - * @zh - * 设置当前组件的可视编号。(我们不希望用户自行做处理,除非用户自己知道在做什么) - * - * @deprecated 会在 Cocos Creator 3D beta18 及之后的版本废除 - */ - public setVisibility (value: number) { - return; - // this._visibility = value; - } - public _setScreen(value: CanvasComponent){ this._followScreen = value; } diff --git a/cocos/core/data/class.ts b/cocos/core/data/class.ts index 86aec05f93..bd57635501 100644 --- a/cocos/core/data/class.ts +++ b/cocos/core/data/class.ts @@ -857,12 +857,8 @@ function declareProperties (cls, className, properties, baseClass, mixins, es6?: } /** - * @module cc - */ - -/** - * @en Defines a CCClass using the given specification, please see [Class](/docs/editors_and_tools/creator-chapters/scripting/class.html) for details. - * @zh 定义一个 CCClass,传入参数必须是一个包含类型参数的字面量对象,具体用法请查阅[类型定义](/docs/creator/scripting/class.html)。 + * @en Defines a CCClass using the given specification + * @zh 定义一个 CCClass,传入参数必须是一个包含类型参数的字面量对象 * * @method Class * diff --git a/cocos/core/director.ts b/cocos/core/director.ts index 95b10e6282..297468d21e 100644 --- a/cocos/core/director.ts +++ b/cocos/core/director.ts @@ -885,8 +885,8 @@ export class Director extends EventTarget { } /** - * @en Returns the FPS value. Please use {{#crossLink "Game.setFrameRate"}}cc.game.setFrameRate{{/crossLink}} to control animation interval. - * @zh 获取单位帧执行时间。请使用 {{#crossLink "Game.setFrameRate"}}cc.game.setFrameRate{{/crossLink}} 来控制游戏帧率。 + * @en Returns the FPS value. Please use [[Game.setFrameRate]] to control animation interval. + * @zh 获取单位帧执行时间。请使用 [[Game.setFrameRate]] 来控制游戏帧率。 * @deprecated since v2.0 * @return {Number} */ diff --git a/cocos/core/geom-utils/sphere.ts b/cocos/core/geom-utils/sphere.ts index 0ef7a5b442..f4b5077009 100644 --- a/cocos/core/geom-utils/sphere.ts +++ b/cocos/core/geom-utils/sphere.ts @@ -110,9 +110,9 @@ export default class sphere { /** * 构造一个球。 - * @param cx 形状的相对于原点的 X 坐标。 - * @param cy 形状的相对于原点的 Y 坐标。 - * @param cz 形状的相对于原点的 Z 坐标。 + * @param cx 该球的世界坐标的 X 坐标。 + * @param cy 该球的世界坐标的 Y 坐标。 + * @param cz 该球的世界坐标的 Z 坐标。 * @param {number} r 半径。 */ constructor (cx: number = 0, cy: number = 0, cz: number = 0, r: number = 1) { diff --git a/cocos/core/load-pipeline/loading-items.ts b/cocos/core/load-pipeline/loading-items.ts index 622c16ada3..65f50ab726 100644 --- a/cocos/core/load-pipeline/loading-items.ts +++ b/cocos/core/load-pipeline/loading-items.ts @@ -145,7 +145,7 @@ function checkCircleReference(owner, item:IItem, recursiveCall?) { /** * @en * LoadingItems is the queue of items which can flow them into the loading pipeline.
- * Please don't construct it directly, use {{#crossLink "LoadingItems.create"}}cc.LoadingItems.create{{/crossLink}} instead, because we use an internal pool to recycle the queues.
+ * Please don't construct it directly, use [[create]] instead, because we use an internal pool to recycle the queues.
* It hold a map of items, each entry in the map is a url to object key value pair.
* Each item always contains the following property:
* - id: The identification of the item, usually it's identical to url
@@ -161,7 +161,7 @@ function checkCircleReference(owner, item:IItem, recursiveCall?) { * So please don't hold its reference for later usage, you can copy properties in it though. * @zh * LoadingItems 是一个加载对象队列,可以用来输送加载对象到加载管线中。
- * 请不要直接使用 new 构造这个类的对象,你可以使用 {{#crossLink "LoadingItems.create"}}cc.LoadingItems.create{{/crossLink}} 来创建一个新的加载队列,这样可以允许我们的内部对象池回收并重利用加载队列。 + * 请不要直接使用 new 构造这个类的对象,你可以使用 [[create]] 来创建一个新的加载队列,这样可以允许我们的内部对象池回收并重利用加载队列。 * 它有一个 map 属性用来存放加载项,在 map 对象中已 url 为 key 值。
* 每个对象都会包含下列属性:
* - id:该对象的标识,通常与 url 相同。
@@ -234,7 +234,7 @@ export class LoadingItems extends CallbacksInvoker { * ``` */ public onComplete:Function|undefined; - + /** * @en The map of all items. * @zh 存储所有加载项的对象。 @@ -318,8 +318,8 @@ export class LoadingItems extends CallbacksInvoker { * @static * @param {Pipeline} pipeline The pipeline to process the queue. * @param {Array} urlList The items array. - * @param {Function} [onProgress] The progression callback, refer to {{#crossLink "LoadingItems.onProgress"}}{{/crossLink}} - * @param {Function} [onComplete] The completion callback, refer to {{#crossLink "LoadingItems.onComplete"}}{{/crossLink}} + * @param {Function} [onProgress] The progression callback, refer to [[onProgress]] + * @param {Function} [onComplete] The completion callback, refer to [[LoadingItems.onComplete]] * @return {LoadingItems} The LoadingItems queue object * @example * ``` diff --git a/cocos/core/load-pipeline/pipeline.ts b/cocos/core/load-pipeline/pipeline.ts index e99b128e07..44205a37d5 100644 --- a/cocos/core/load-pipeline/pipeline.ts +++ b/cocos/core/load-pipeline/pipeline.ts @@ -378,10 +378,10 @@ export class Pipeline { * @en Removes an completed item in pipeline. * It will only remove the cache in the pipeline or loader, its dependencies won't be released. * cc.loader provided another method to completely cleanup the resource and its dependencies, - * please refer to {{#crossLink "loader/release:method"}}cc.loader.release{{/crossLink}} + * please refer to [[Loader.release]] * @zh 移除指定的已完成 item。 * 这将仅仅从 pipeline 或者 loader 中删除其缓存,并不会释放它所依赖的资源。 - * cc.loader 中提供了另一种删除资源及其依赖的清理方法,请参考 {{#crossLink "loader/release:method"}}cc.loader.release{{/crossLink}} + * cc.loader 中提供了另一种删除资源及其依赖的清理方法,请参考 [[Loader.release]] * @method removeItem * @param {Object} id The id of the item * @return {Boolean} succeed or not diff --git a/cocos/core/math/mat3.ts b/cocos/core/math/mat3.ts index dc4a7513e6..1d42827485 100644 --- a/cocos/core/math/mat3.ts +++ b/cocos/core/math/mat3.ts @@ -683,13 +683,13 @@ export class Mat3 extends ValueType { /** * 设置当前矩阵使其与指定矩阵相等。 * @param other 相比较的矩阵。 - * @returns `this` + * @return this */ public set (other: Mat3); /** * 设置当前矩阵指定元素值。 - * @returns `this` + * @return this */ public set (m00?: number, m01?: number, m02?: number, m03?: number, m04?: number, m05?: number, @@ -714,7 +714,7 @@ export class Mat3 extends ValueType { * 判断当前矩阵是否在误差范围内与指定矩阵相等。 * @param other 相比较的矩阵。 * @param epsilon 允许的误差,应为非负数。 - * @returns 两矩阵的各元素都分别相等时返回 `true`;否则返回 `false`。 + * @return 两矩阵的各元素都分别相等时返回 `true`;否则返回 `false`。 */ public equals (other: Mat3, epsilon = EPSILON): boolean { return ( @@ -733,7 +733,7 @@ export class Mat3 extends ValueType { /** * 判断当前矩阵是否与指定矩阵相等。 * @param other 相比较的矩阵。 - * @returns 两矩阵的各元素都分别相等时返回 `true`;否则返回 `false`。 + * @return 两矩阵的各元素都分别相等时返回 `true`;否则返回 `false`。 */ public strictEquals (other: Mat3): boolean { return this.m00 === other.m00 && this.m01 === other.m01 && this.m02 === other.m02 && @@ -743,7 +743,7 @@ export class Mat3 extends ValueType { /** * 返回当前矩阵的字符串表示。 - * @returns 当前矩阵的字符串表示。 + * @return 当前矩阵的字符串表示。 */ public toString () { const t = this; @@ -756,7 +756,7 @@ export class Mat3 extends ValueType { /** * 将当前矩阵设为单位矩阵。 - * @returns `this` + * @return `this` */ public identity () { this.m00 = 1; @@ -819,7 +819,7 @@ export class Mat3 extends ValueType { /** * 计算当前矩阵的行列式。 - * @returns 当前矩阵的行列式。 + * @return 当前矩阵的行列式。 */ public determinant (): number { _a00 = this.m00; _a01 = this.m01; _a02 = this.m02; @@ -958,7 +958,7 @@ export class Mat3 extends ValueType { /** * 重置当前矩阵的值,使其表示指定四元数表示的旋转变换。 * @param q 四元数表示的旋转变换。 - * @returns `this` + * @returns this */ public fromQuat (q: Quat) { const x = q.x, y = q.y, z = q.z, w = q.w; diff --git a/cocos/core/math/mat4.ts b/cocos/core/math/mat4.ts index 3b9dc05f82..1fd4c9cd8f 100644 --- a/cocos/core/math/mat4.ts +++ b/cocos/core/math/mat4.ts @@ -1456,13 +1456,13 @@ export class Mat4 extends ValueType { /** * 设置当前矩阵使其与指定矩阵相等。 * @param other 相比较的矩阵。 - * @returns `this` + * @return this */ public set (other: Mat4); /** * 设置当前矩阵指定元素值。 - * @returns `this` + * @return this */ public set ( m00?: number, m01?: number, m02?: number, m03?: number, @@ -1492,7 +1492,7 @@ export class Mat4 extends ValueType { * 判断当前矩阵是否在误差范围内与指定矩阵相等。 * @param other 相比较的矩阵。 * @param epsilon 允许的误差,应为非负数。 - * @returns 两矩阵的各元素都分别相等时返回 `true`;否则返回 `false`。 + * @return 两矩阵的各元素都分别相等时返回 `true`;否则返回 `false`。 */ public equals (other: Mat4, epsilon = EPSILON): boolean { return ( @@ -1518,7 +1518,7 @@ export class Mat4 extends ValueType { /** * 判断当前矩阵是否与指定矩阵相等。 * @param other 相比较的矩阵。 - * @returns 两矩阵的各元素都分别相等时返回 `true`;否则返回 `false`。 + * @return 两矩阵的各元素都分别相等时返回 `true`;否则返回 `false`。 */ public strictEquals (other: Mat4): boolean { return this.m00 === other.m00 && this.m01 === other.m01 && this.m02 === other.m02 && this.m03 === other.m03 && @@ -1529,7 +1529,7 @@ export class Mat4 extends ValueType { /** * 返回当前矩阵的字符串表示。 - * @returns 当前矩阵的字符串表示。 + * @return 当前矩阵的字符串表示。 */ public toString () { return '[\n' + @@ -1542,7 +1542,7 @@ export class Mat4 extends ValueType { /** * 将当前矩阵设为单位矩阵。 - * @returns `this` + * @return `this` */ public identity () { this.m00 = 1; @@ -1634,7 +1634,7 @@ export class Mat4 extends ValueType { /** * 计算当前矩阵的行列式。 - * @returns 当前矩阵的行列式。 + * @return 当前矩阵的行列式。 */ public determinant (): number { _a00 = this.m00; _a01 = this.m01; _a02 = this.m02; _a03 = this.m03; @@ -1931,7 +1931,7 @@ export class Mat4 extends ValueType { * @param q 四元数表示的旋转变换。 * @param v 位移变换,表示为各个轴的位移。 * @param s 缩放变换,表示为各个轴的缩放。 - * @returns `this` + * @return `this` */ public fromRTS (q: Quat, v: Vec3, s: Vec3) { const x = q.x, y = q.y, z = q.z, w = q.w; @@ -1975,7 +1975,7 @@ export class Mat4 extends ValueType { /** * 重置当前矩阵的值,使其表示指定四元数表示的旋转变换。 * @param q 四元数表示的旋转变换。 - * @returns `this` + * @return `this` */ public fromQuat (q: Quat) { const x = q.x, y = q.y, z = q.z, w = q.w; diff --git a/cocos/core/math/vec2.ts b/cocos/core/math/vec2.ts index 7cc8b75e2b..8ff05af95f 100644 --- a/cocos/core/math/vec2.ts +++ b/cocos/core/math/vec2.ts @@ -423,7 +423,7 @@ export class Vec2 extends ValueType { /** * 设置当前向量使其与指定向量相等。 * @param other 相比较的向量。 - * @returns `this` + * @return `this` */ public set (other: Vec2); @@ -431,7 +431,7 @@ export class Vec2 extends ValueType { * 设置当前向量的具体分量值。 * @param x 要设置的 x 分量的值 * @param y 要设置的 y 分量的值 - * @returns `this` + * @return `this` */ public set (x?: number, y?: number); @@ -450,7 +450,7 @@ export class Vec2 extends ValueType { * 判断当前向量是否在误差范围内与指定向量相等。 * @param other 相比较的向量。 * @param epsilon 允许的误差,应为非负数。 - * @returns 当两向量的各分量都在指定的误差范围内分别相等时,返回 `true`;否则返回 `false`。 + * @return 当两向量的各分量都在指定的误差范围内分别相等时,返回 `true`;否则返回 `false`。 */ public equals (other: Vec2, epsilon = EPSILON) { return ( @@ -466,7 +466,7 @@ export class Vec2 extends ValueType { * @param x 相比较的向量的 x 分量。 * @param y 相比较的向量的 y 分量。 * @param epsilon 允许的误差,应为非负数。 - * @returns 当两向量的各分量都在指定的误差范围内分别相等时,返回 `true`;否则返回 `false`。 + * @return 当两向量的各分量都在指定的误差范围内分别相等时,返回 `true`;否则返回 `false`。 */ public equals2f (x: number, y: number, epsilon = EPSILON) { return ( @@ -480,7 +480,7 @@ export class Vec2 extends ValueType { /** * 判断当前向量是否与指定向量相等。 * @param other 相比较的向量。 - * @returns 两向量的各分量都分别相等时返回 `true`;否则返回 `false`。 + * @return 两向量的各分量都分别相等时返回 `true`;否则返回 `false`。 */ public strictEquals (other: Vec2) { return other && this.x === other.x && this.y === other.y; @@ -490,7 +490,7 @@ export class Vec2 extends ValueType { * 判断当前向量是否与指定分量的向量相等。 * @param x 指定向量的 x 分量。 * @param y 指定向量的 y 分量。 - * @returns 两向量的各分量都分别相等时返回 `true`;否则返回 `false`。 + * @return 两向量的各分量都分别相等时返回 `true`;否则返回 `false`。 */ public strictEquals2f (x: number, y: number) { return this.x === x && this.y === y; @@ -498,7 +498,7 @@ export class Vec2 extends ValueType { /** * 返回当前向量的字符串表示。 - * @returns 当前向量的字符串表示。 + * @return 当前向量的字符串表示。 */ public toString () { return `(${this.x.toFixed(2)}, ${this.y.toFixed(2)})`; @@ -521,7 +521,7 @@ export class Vec2 extends ValueType { * 设置当前向量的值,使其各个分量都处于指定的范围内。 * @param minInclusive 每个分量都代表了对应分量允许的最小值。 * @param maxInclusive 每个分量都代表了对应分量允许的最大值。 - * @returns `this` + * @return `this` */ public clampf (minInclusive: Vec2, maxInclusive: Vec2) { this.x = clamp(this.x, minInclusive.x, maxInclusive.x); @@ -637,7 +637,7 @@ export class Vec2 extends ValueType { /** * 向量点乘。 * @param other 指定的向量。 - * @returns 当前向量与指定向量点乘的结果。 + * @return 当前向量与指定向量点乘的结果。 */ public dot (other: Vec2) { return this.x * other.x + this.y * other.y; @@ -646,7 +646,7 @@ export class Vec2 extends ValueType { /** * 向量叉乘。 * @param other 指定的向量。 - * @returns `out` + * @return `out` */ public cross (other: Vec2) { return this.x * other.y - this.y * other.x; @@ -654,7 +654,7 @@ export class Vec2 extends ValueType { /** * 计算向量的长度(模)。 - * @returns 向量的长度(模)。 + * @return 向量的长度(模)。 */ public length () { return Math.sqrt(this.x * this.x + this.y * this.y); @@ -662,7 +662,7 @@ export class Vec2 extends ValueType { /** * 计算向量长度(模)的平方。 - * @returns 向量长度(模)的平方。 + * @return 向量长度(模)的平方。 */ public lengthSqr () { return this.x * this.x + this.y * this.y; @@ -686,7 +686,7 @@ export class Vec2 extends ValueType { /** * 获取当前向量和指定向量之间的角度。 * @param other 指定的向量。 - * @returns 当前向量和指定向量之间的角度(弧度制);若当前向量和指定向量中存在零向量,将返回 0。 + * @return 当前向量和指定向量之间的角度(弧度制);若当前向量和指定向量中存在零向量,将返回 0。 */ public angle (other: Vec2) { const magSqr1 = this.lengthSqr(); @@ -707,7 +707,7 @@ export class Vec2 extends ValueType { * 获取当前向量和指定向量之间的有符号角度。 * 有符号角度的取值范围为 (-180, 180],当前向量可以通过逆时针旋转有符号角度与指定向量同向。 * @param other 指定的向量。 - * @returns 当前向量和指定向量之间的有符号角度(弧度制);若当前向量和指定向量中存在零向量,将返回 0。 + * @return 当前向量和指定向量之间的有符号角度(弧度制);若当前向量和指定向量中存在零向量,将返回 0。 */ public signAngle (other: Vec2) { const angle = this.angle(other); diff --git a/cocos/core/pipeline/render-queue.ts b/cocos/core/pipeline/render-queue.ts index 71035321c9..07a9763b84 100644 --- a/cocos/core/pipeline/render-queue.ts +++ b/cocos/core/pipeline/render-queue.ts @@ -10,7 +10,7 @@ import { IRenderObject, IRenderPass, IRenderQueueDesc } from './define'; * @en * Comparison sorting function. Opaque objects are sorted by depth priority -> depth front to back -> shader id. * @zh - * 比较排序函数。不透对象按优先级 -> 深度由前向后 -> ShaderId 顺序排序。 + * 比较排序函数。不透明对象按优先级 -> 深度由前向后 -> ShaderId 顺序排序。 */ export function opaqueCompareFn (a: IRenderPass, b: IRenderPass) { if (a.hash === b.hash) { @@ -28,7 +28,7 @@ export function opaqueCompareFn (a: IRenderPass, b: IRenderPass) { * @en * Comparison sorting function. Transparent objects are sorted by pass priority -> depth back to front -> shader id. * @zh - * 比较排序函数。半透对象按优先级 -> 深度由后向前 -> ShaderId 顺序排序。 + * 比较排序函数。半透明对象按优先级 -> 深度由后向前 -> ShaderId 顺序排序。 */ export function transparentCompareFn (a: IRenderPass, b: IRenderPass) { if (a.hash === b.hash) { diff --git a/cocos/core/platform/event-manager/event-listener.ts b/cocos/core/platform/event-manager/event-listener.ts index ac1fbf1a22..ff216c7922 100644 --- a/cocos/core/platform/event-manager/event-listener.ts +++ b/cocos/core/platform/event-manager/event-listener.ts @@ -54,7 +54,7 @@ export interface ILinstenerMask { * * @zh * 封装用户的事件处理逻辑。
- * 注意:这是一个抽象类,开发者不应该直接实例化这个类,请参考 [[cc.EventListener.create]] 。 + * 注意:这是一个抽象类,开发者不应该直接实例化这个类,请参考 [[create]] 。 */ export class EventListener { diff --git a/cocos/core/scene-graph/base-node.ts b/cocos/core/scene-graph/base-node.ts index 6f880779c0..2d60599f07 100644 --- a/cocos/core/scene-graph/base-node.ts +++ b/cocos/core/scene-graph/base-node.ts @@ -177,12 +177,12 @@ export class BaseNode extends CCObject implements IBaseNode, ISchedulable { * @en * The local active state of this node.
* Note that a Node may be inactive because a parent is not active, even if this returns true.
- * Use {{#crossLink "Node/activeInHierarchy:property"}}{{/crossLink}} + * Use [[activeInHierarchy]] * if you want to check if the Node is actually treated as active in the scene. * @zh * 当前节点的自身激活状态。
* 值得注意的是,一个节点的父节点如果不被激活,那么即使它自身设为激活,它仍然无法激活。
- * 如果你想检查节点在场景中实际的激活状态可以使用 {{#crossLink "Node/activeInHierarchy:property"}}{{/crossLink}}。 + * 如果你想检查节点在场景中实际的激活状态可以使用 [[activeInHierarchy]] * @property active * @type {Boolean} * @default true @@ -216,6 +216,7 @@ export class BaseNode extends CCObject implements IBaseNode, ISchedulable { * @example * ``` * cc.log("activeInHierarchy: " + node.activeInHierarchy); + * ``` */ @property get activeInHierarchy () { diff --git a/cocos/core/scene-graph/node-event-processor.ts b/cocos/core/scene-graph/node-event-processor.ts index fa27dda43d..22915f20b9 100644 --- a/cocos/core/scene-graph/node-event-processor.ts +++ b/cocos/core/scene-graph/node-event-processor.ts @@ -386,7 +386,7 @@ export class NodeEventProcessor { * 鼠标或触摸事件会被系统调用 dispatchEvent 方法触发,触发的过程包含三个阶段:
* 1. 捕获阶段:派发事件给捕获目标(通过 `getCapturingTargets` 获取),比如,节点树中注册了捕获阶段的父节点,从根节点开始派发直到目标节点。
* 2. 目标阶段:派发给目标节点的监听器。
- * 3. 冒泡阶段:派发事件给冒泡目标(通过 `getBubblingTargets` 获取),比如,节点树中注册了冒泡阶段的父节点,从目标节点开始派发知道根节点。
+ * 3. 冒泡阶段:派发事件给冒泡目标(通过 `getBubblingTargets` 获取),比如,节点树中注册了冒泡阶段的父节点,从目标节点开始派发直到根节点。
* 同时您可以将事件派发到父节点或者通过调用 stopPropagation 拦截它。
* 推荐使用这种方式来监听节点上的触摸或鼠标事件,请不要在节点上直接使用 cc.eventManager。
* 你也可以注册自定义事件到节点上,并通过 emit 方法触发此类事件,对于这类事件,不会发生捕获冒泡阶段,只会直接派发给注册在该节点上的监听器。
diff --git a/cocos/core/scene-graph/private-node.ts b/cocos/core/scene-graph/private-node.ts index 04010389e6..d246187b93 100644 --- a/cocos/core/scene-graph/private-node.ts +++ b/cocos/core/scene-graph/private-node.ts @@ -38,7 +38,7 @@ const HideInHierarchy = CCObject.Flags.HideInHierarchy; /** * @en - * Class of private entities in Cocos Creator scenes.
+ * Class of private entities in Cocos Creator 3d scenes.
* The PrivateNode is hidden in editor, and completely transparent to users.
* It's normally used as Node's private content created by components in parent node.
* So in theory private nodes are not children, they are part of the parent node.
@@ -48,7 +48,7 @@ const HideInHierarchy = CCObject.Flags.HideInHierarchy; * In this way, they can be easily kept inside the bounding box.
* Currently, it's used by RichText component and TileMap component. * @zh - * Cocos Creator 场景中的私有节点类。
+ * Cocos Creator 3d场景中的私有节点类。
* 私有节点在编辑器中不可见,对用户透明。
* 通常私有节点是被一些特殊的组件创建出来作为父节点的一部分而存在的,理论上来说,它们不是子节点,而是父节点的组成部分。
* 私有节点有两个非常重要的特性:
diff --git a/cocos/core/splash-image.ts b/cocos/core/splash-image.ts index 598cce4f99..5b97b69c05 100644 --- a/cocos/core/splash-image.ts +++ b/cocos/core/splash-image.ts @@ -1,3 +1,7 @@ +/** + * @hidden + */ + import { GFXDevice } from "./gfx/device"; import { GFXCommandBuffer } from "./gfx/command-buffer"; import { GFXCommandBufferType, GFXBufferUsageBit, GFXClearFlag, IGFXRect, GFXTextureType, GFXTextureUsageBit, GFXFormat, GFXTextureViewType, GFXMemoryUsageBit, GFXBufferTextureCopy } from "./gfx/define"; diff --git a/cocos/core/utils/interfaces.ts b/cocos/core/utils/interfaces.ts index cf65787685..387807989c 100644 --- a/cocos/core/utils/interfaces.ts +++ b/cocos/core/utils/interfaces.ts @@ -101,12 +101,12 @@ export interface IBaseNode { * @en * The local active state of this node.
* Note that a Node may be inactive because a parent is not active, even if this returns true.
- * Use {{#crossLink "Node/activeInHierarchy:property"}}{{/crossLink}} + * Use [[activeInHierarchy]] * if you want to check if the Node is actually treated as active in the scene. * @zh * 当前节点的自身激活状态。
* 值得注意的是,一个节点的父节点如果不被激活,那么即使它自身设为激活,它仍然无法激活。
- * 如果你想检查节点在场景中实际的激活状态可以使用 {{#crossLink "Node/activeInHierarchy:property"}}{{/crossLink}}。 + * 如果你想检查节点在场景中实际的激活状态可以使用 [[activeInHierarchy]] * @property active * @type {Boolean} * @default true diff --git a/cocos/core/utils/js-typed.ts b/cocos/core/utils/js-typed.ts index 5523f16fc8..492eb294b7 100644 --- a/cocos/core/utils/js-typed.ts +++ b/cocos/core/utils/js-typed.ts @@ -342,7 +342,7 @@ export function mixin (object?: any, ...sources: any[]) { /** * Derive the class from the supplied base class. * Both classes are just native javascript constructors, not created by cc.Class, so - * usually you will want to inherit using {{#crossLink "cc/Class:method"}}cc.Class {{/crossLink}} instead. + * usually you will want to inherit using [[Class]] instead. * @param base The baseclass to inherit. * @return The result class. */ diff --git a/cocos/particle/particle-system-component.ts b/cocos/particle/particle-system-component.ts index c0c60ccee0..337b3a2069 100644 --- a/cocos/particle/particle-system-component.ts +++ b/cocos/particle/particle-system-component.ts @@ -499,7 +499,7 @@ export class ParticleSystemComponent extends RenderableComponent { } /** - * @zh 获取当前。 + * @zh 获取当前粒子数量 */ public getParticleCount () { return this.renderer!.getParticleCount();