Optimize some documents

cocos/core/3d/framework/camera-component.ts

@@ -549,7 +549,7 @@ export class CameraComponent extends Component {
      * @param out 返回在当前传入的 UI 节点下的偏移量
      *
      * @example
-     * ```typescript
+     * ```ts
      * this.convertToUINode(target.worldPosition, uiNode.parent, out);
      * uiNode.position = out;
      * ```

cocos/core/animation/animation-component.ts

@@ -392,7 +392,7 @@ export class AnimationComponent extends Eventify(Component) {
      * @param target The callee when invoke the callback, could be absent
      * @return The registered callback
      * @example
-     * ```typescript
+     * ```ts
      * onPlay: function (type, state) {
      *     // callback
      * }
@@ -426,7 +426,7 @@ export class AnimationComponent extends Eventify(Component) {
      * @param {Function} callback The callback to unregister
      * @param {Object} target The callee of the callback, could be absent
      * @example
-     * ```typescript
+     * ```ts
      * // unregister event to all animation
      * animation.off('play', this.onPlay, this);
      * ```

cocos/core/assets/asset.ts

@@ -42,16 +42,16 @@ import { errorID } from '../platform/debug';
  * You may want to override:<br/>
  * - createNode<br/>
  * - getset functions of _nativeAsset<br/>
- * - cc.Object._serialize<br/>
- * - cc.Object._deserialize<br/>
+ * - `Object._serialize`<br/>
+ * - `Object._deserialize`<br/>
  * @zh
  * Creator 中的资源基类。<br/>
  *
  * 您可能需要重写：<br/>
  * - createNode <br/>
  * - _nativeAsset 的 getset 方法<br/>
- * - cc.Object._serialize<br/>
- * - cc.Object._deserialize<br/>
+ * - `Object._serialize`<br/>
+ * - `Object._deserialize`<br/>
  *
  * @class Asset
  * @extends RawAsset

cocos/core/assets/prefab.ts

@@ -90,7 +90,7 @@ export default class Prefab extends Asset {
      * @default Prefab.OptimizationPolicy.AUTO
      * @since 1.10.0
      * @example
-     * ```typescript
+     * ```ts
      * prefab.optimizationPolicy = cc.Prefab.OptimizationPolicy.MULTI_INSTANCE;
      * ```
      */

cocos/core/assets/sprite-frame.ts

@@ -129,22 +129,23 @@ const temp_uvs: IUV[] = [{ u: 0, v: 0 }, { u: 0, v: 0 }, { u: 0, v: 0 }, { u: 0,
 
 /**
  * @en
- * A cc.SpriteFrame has:<br/>
- *  - texture: A cc.Texture2D that will be used by render components<br/>
+ * A `SpriteFrame` has:<br/>
+ *  - texture: A `Texture2D` that will be used by render components<br/>
  *  - rectangle: A rectangle of the texture
  *
  * @zh
  * 精灵帧资源。
  * 一个 SpriteFrame 包含：<br/>
  *  - 纹理：会被渲染组件使用的 Texture2D 对象。<br/>
  *  - 矩形：在纹理中的矩形区域。
- * 可通过 cc.SpriteFrame 获取该组件。
+ * 可通过 `SpriteFrame` 获取该组件。
  *
  * @example
- * ```typescript
+ * ```ts
+ * import { loader } from 'cc';
  * // First way to use a SpriteFrame
  * const url = "assets/PurpleMonster/icon/spriteFrame";
- * cc.loader.loadRes(url, (err, spriteFrame) => {
+ * loader.loadRes(url, (err, spriteFrame) => {
  *   const node = new Node("New Sprite");
  *   const sprite = node.addComponent(SpriteComponent);
  *   sprite.spriteFrame = spriteFrame;
@@ -154,7 +155,7 @@ const temp_uvs: IUV[] = [{ u: 0, v: 0 }, { u: 0, v: 0 }, { u: 0, v: 0 }, { u: 0,
  * // Second way to use a SpriteFrame
  * const self = this;
  * const url = "test_assets/PurpleMonster";
- * cc.loader.loadRes(url, (err, imageAsset) => {
+ * loader.loadRes(url, (err, imageAsset) => {
  *  if(err){
  *    return;
  *  }

cocos/core/assets/texture-cube.ts

@@ -122,7 +122,7 @@ export class TextureCube extends SimpleTexture {
      * @param out 出口立方体贴图，若未定义则将创建为新的立方体贴图。
      * @returns `out`
      * @example
-     * ```typescript
+     * ```ts
      * const textures = new Array<Texture2D>(6);
      * textures[TextureCube.FaceIndex.front] = frontImage;
      * textures[TextureCube.FaceIndex.back] = backImage;

cocos/core/components/component-event-handler.ts

@@ -38,7 +38,7 @@ import { legacyCC } from '../global-exports';
  * 可通过 cc.Component.EventHandler 获得该事件。
  *
  * @example
- * ```typescript
+ * ```ts
  *
  * var eventHandler = new cc.Component.EventHandler();
  * eventHandler.target = newTarget;
@@ -113,7 +113,7 @@ export class EventHandler {
      *
      * @param params - 派发参数数组。
      * @example
-     * ```typescript
+     * ```ts
      * var eventHandler = new cc.Component.EventHandler();
      * eventHandler.target = newTarget;
      * eventHandler.component = "MainMenu";

cocos/core/components/component.ts

@@ -93,8 +93,9 @@ class Component extends CCObject {
      * @type {String}
      * @readOnly
      * @example
-     * ```typescript
-     * cc.log(comp.uuid);
+     * ```ts
+     * import { log } from 'cc';
+     * log(comp.uuid);
      * ```
      */
     @property({
@@ -118,9 +119,10 @@ class Component extends CCObject {
      * @type {Boolean}
      * @default true
      * @example
-     * ```typescript
+     * ```ts
+     * import { log } from 'cc';
      * comp.enabled = true;
-     * cc.log(comp.enabled);
+     * log(comp.enabled);
      * ```
      */
     @property({
@@ -151,8 +153,9 @@ class Component extends CCObject {
      * @type {Boolean}
      * @readOnly
      * @example
-     * ```typescript
-     * cc.log(comp.enabledInHierarchy);
+     * ```ts
+     * import { log } from 'cc';
+     * log(comp.enabledInHierarchy);
      * ```
      */
     @property({
@@ -169,8 +172,9 @@ class Component extends CCObject {
      * @type {Number}
      * @readOnly
      * @example
-     * ```typescript
-     * cc.log(this._isOnLoadCalled > 0);
+     * ```ts
+     * import { log } from 'cc';
+     * log(this._isOnLoadCalled > 0);
      * ```
      */
     get _isOnLoadCalled () {
@@ -184,8 +188,9 @@ class Component extends CCObject {
      * @property node
      * @type {Node}
      * @example
-     * ```typescript
-     * cc.log(comp.node);
+     * ```ts
+     * import { log } from 'cc';
+     * log(comp.node);
      * ```
      */
     @property({
@@ -224,7 +229,7 @@ class Component extends CCObject {
      * @en Adds a component class to the node. You can also add component to node by passing in the name of the script.
      * @zh 向节点添加一个指定类型的组件类，你还可以通过传入脚本的名称来添加组件。
      * @example
-     * ```typescript
+     * ```ts
      * var sprite = node.addComponent(cc.SpriteComponent);
      * ```
      */
@@ -234,7 +239,7 @@ class Component extends CCObject {
      * @en Adds a component class to the node. You can also add component to node by passing in the name of the script.
      * @zh 向节点添加一个指定类型的组件类，你还可以通过传入脚本的名称来添加组件。
      * @example
-     * ```typescript
+     * ```ts
      * var test = node.addComponent("Test");
      * ```
      */
@@ -252,7 +257,7 @@ class Component extends CCObject {
      * 获取节点上指定类型的组件，如果节点有附加指定类型的组件，则返回，如果没有则为空。<br/>
      * 传入参数也可以是脚本的名称。
      * @example
-     * ```typescript
+     * ```ts
      * // get sprite component.
      * var sprite = node.getComponent(cc.SpriteComponent);
      * ```
@@ -267,7 +272,7 @@ class Component extends CCObject {
      * 获取节点上指定类型的组件，如果节点有附加指定类型的组件，则返回，如果没有则为空。<br/>
      * 传入参数也可以是脚本的名称。
      * @example
-     * ```typescript
+     * ```ts
      * // get custom test calss.
      * var test = node.getComponent("Test");
      * ```
@@ -282,7 +287,7 @@ class Component extends CCObject {
      * @en Returns all components of supplied type in the node.
      * @zh 返回节点上指定类型的所有组件。
      * @example
-     * ```typescript
+     * ```ts
      * var sprites = node.getComponents(cc.SpriteComponent);
      * ```
      */
@@ -292,7 +297,7 @@ class Component extends CCObject {
      * @en Returns all components of supplied type in the node.
      * @zh 返回节点上指定类型的所有组件。
      * @example
-     * ```typescript
+     * ```ts
      * var tests = node.getComponents("Test");
      * ```
      */
@@ -306,7 +311,7 @@ class Component extends CCObject {
      * @en Returns the component of supplied type in any of its children using depth first search.
      * @zh 递归查找所有子节点中第一个匹配指定类型的组件。
      * @example
-     * ```typescript
+     * ```ts
      * var sprite = node.getComponentInChildren(cc.SpriteComponent);
      * ```
      */
@@ -316,7 +321,7 @@ class Component extends CCObject {
      * @en Returns the component of supplied type in any of its children using depth first search.
      * @zh 递归查找所有子节点中第一个匹配指定类型的组件。
      * @example
-     * ```typescript
+     * ```ts
      * var Test = node.getComponentInChildren("Test");
      * ```
      */
@@ -330,7 +335,7 @@ class Component extends CCObject {
      * @en Returns all components of supplied type in self or any of its children.
      * @zh 递归查找自身或所有子节点中指定类型的组件。
      * @example
-     * ```typescript
+     * ```ts
      * var sprites = node.getComponentsInChildren(cc.SpriteComponent);
      * ```
      */
@@ -340,7 +345,7 @@ class Component extends CCObject {
      * @en Returns all components of supplied type in self or any of its children.
      * @zh 递归查找自身或所有子节点中指定类型的组件。
      * @example
-     * ```typescript
+     * ```ts
      * var tests = node.getComponentsInChildren("Test");
      * ```
      */
@@ -411,11 +416,9 @@ class Component extends CCObject {
      * @param {Number} repeat    将被重复执行（repeat+ 1）次，您可以使用 cc.macro.REPEAT_FOREVER 进行无限次循环。
      * @param {Number} delay     第一次执行前等待的时间（延时执行）。
      * @example
-     * ```typescript
-     * var timeCallback = function (dt) {
-     *   cc.log("time: " + dt);
-     * }
-     * this.schedule(timeCallback, 1);
+     * ```ts
+     * import { log } from 'cc';
+     * this.schedule((dt) => void log(`time: ${dt}`), 1);
      * ```
      */
     public schedule (callback, interval: number = 0, repeat: number = legacyCC.macro.REPEAT_FOREVER, delay: number = 0) {
@@ -445,23 +448,21 @@ class Component extends CCObject {
      * @param {function} callback  回调函数。
      * @param {Number} delay  第一次执行前等待的时间（延时执行）。
      * @example
-     * ```typescript
-     * var timeCallback = function (dt) {
-     *   cc.log("time: " + dt);
-     * }
-     * this.scheduleOnce(timeCallback, 2);
+     * ```ts
+     * import { log } from 'cc';
+     * this.scheduleOnce((dt) => void log(`time: ${dt}`), 2);
      * ```
      */
     public scheduleOnce (callback, delay: number = 0) {
         this.schedule(callback, 0, 0, delay);
     }
 
     /**
-     * @en Unschedules a custom callback function.
+     * @en Un-schedules a custom callback function.
      * @zh 取消调度一个自定义的回调函数。
      * @param {function} callback_fn  回调函数。
      * @example
-     * ```typescript
+     * ```ts
      * this.unschedule(_callback);
      * ```
      */
@@ -480,7 +481,7 @@ class Component extends CCObject {
      * @zh 取消调度所有已调度的回调函数：定制的回调函数以及 'update' 回调函数。动作不受此方法影响。
      * @method unscheduleAllCallbacks
      * @example
-     * ```typescript
+     * ```ts
      * this.unscheduleAllCallbacks();
      * ```
      */

cocos/core/components/ui-base/ui-render-component.ts

@@ -127,7 +127,7 @@ export class UIRenderComponent extends UIComponent {
      *
      * @param value 原图混合模式。
      * @example
-     * ```typescript
+     * ```ts
      * sprite.srcBlendFactor = GFXBlendFactor.ONE;
      * ```
      */
@@ -158,7 +158,7 @@ export class UIRenderComponent extends UIComponent {
      *
      * @param value 目标混合模式。
      * @example
-     * ```typescript
+     * ```ts
      * sprite.dstBlendFactor = GFXBlendFactor.ONE;
      * ```
      */

cocos/core/components/ui-base/ui-transform-component.ts

@@ -277,7 +277,7 @@ export class UITransformComponent extends Component {
      * @param size - 节点内容变换的尺寸或者宽度。
      * @param height - 节点内容未变换的高度。
      * @example
-     * ```typescript
+     * ```ts
      * node.setContentSize(cc.size(100, 100));
      * node.setContentSize(100, 100);
      * ```
@@ -338,7 +338,7 @@ export class UITransformComponent extends Component {
      * @param point - 节点锚点或节点 x 轴锚。
      * @param y - 节点 y 轴锚。
      * @example
-     * ```typescript
+     * ```ts
      * node.setAnchorPoint(cc.v2(1, 1));
      * node.setAnchorPoint(1, 1);
      * ```
@@ -438,7 +438,7 @@ export class UITransformComponent extends Component {
      * @param out - 转换后坐标。
      * @returns - 返回与目标节点的相对位置。
      * @example
-     * ```typescript
+     * ```ts
      * const newVec3 = uiTransform.convertToNodeSpaceAR(cc.v3(100, 100, 0));
      * ```
      */
@@ -463,7 +463,7 @@ export class UITransformComponent extends Component {
      * @param out - 转换后坐标。
      * @returns - 返回 UI 世界坐标系。
      * @example
-     * ```typescript
+     * ```ts
      * const newVec3 = uiTransform.convertToWorldSpaceAR(3(100, 100, 0));
      * ```
      */
@@ -486,7 +486,7 @@ export class UITransformComponent extends Component {
      *
      * @return - 节点大小的包围盒
      * @example
-     * ```typescript
+     * ```ts
      * const boundingBox = uiTransform.getBoundingBox();
      * ```
      */
@@ -514,7 +514,7 @@ export class UITransformComponent extends Component {
      *
      * @returns - 返回世界坐标系下包围盒。
      * @example
-     * ```typescript
+     * ```ts
      * const newRect = uiTransform.getBoundingBoxToWorld();
      * ```
      */