From c6d536899775aa0f4b679334bb5d3ecdb7db1937 Mon Sep 17 00:00:00 2001 From: Jare Guo Date: Tue, 6 Sep 2016 18:03:08 +0800 Subject: [PATCH] add api href for spine official runtime --- extensions/spine/SGSkeleton.js | 17 ++++++--- extensions/spine/Skeleton.js | 64 ++++++++++++++++++++------------ extensions/spine/SkeletonData.js | 6 ++- extensions/spine/index.js | 10 +++++ 4 files changed, 66 insertions(+), 31 deletions(-) diff --git a/extensions/spine/SGSkeleton.js b/extensions/spine/SGSkeleton.js index 386d7b4614..43fd396091 100644 --- a/extensions/spine/SGSkeleton.js +++ b/extensions/spine/SGSkeleton.js @@ -208,7 +208,8 @@ sp._SGSkeleton = _ccsg.Node.extend({ }, /** - * Finds a bone by name. This does a string comparison for every bone. + * Finds a bone by name. This does a string comparison for every bone.
+ * Returns a {{#crossLinkModule "spine"}}spine{{/crossLinkModule}}.Bone object. * @param {String} boneName * @returns {spine.Bone} */ @@ -217,7 +218,9 @@ sp._SGSkeleton = _ccsg.Node.extend({ }, /** - * Finds a slot by name. This does a string comparison for every slot. + * Finds a slot by name. This does a string comparison for every slot.
+ * Returns a {{#crossLinkModule "spine"}}spine{{/crossLinkModule}}.Slot object. + * * @param {String} slotName * @returns {spine.Slot} */ @@ -226,7 +229,9 @@ sp._SGSkeleton = _ccsg.Node.extend({ }, /** - * Finds a skin by name and makes it the active skin. This does a string comparison for every skin. Note that setting the skin does not change which attachments are visible. + * Finds a skin by name and makes it the active skin. This does a string comparison for every skin. Note that setting the skin does not change which attachments are visible.
+ * Returns a {{#crossLinkModule "spine"}}spine{{/crossLinkModule}}.Skin object. + * * @param {string} skinName * @returns {spine.Skin} */ @@ -235,10 +240,12 @@ sp._SGSkeleton = _ccsg.Node.extend({ }, /** - * Returns the attachment for the slot and attachment name. The skeleton looks first in its skin, then in the skeleton data’s default skin. + * Returns the attachment for the slot and attachment name. The skeleton looks first in its skin, then in the skeleton data’s default skin.
+ * Returns a {{#crossLinkModule "spine"}}spine{{/crossLinkModule}}.Attachment object. + * * @param {String} slotName * @param {String} attachmentName - * @returns {spine.RegionAttachment|spine.BoundingBoxAttachment} + * @returns {spine.Attachment} */ getAttachment: function (slotName, attachmentName) { return this._skeleton.getAttachmentBySlotName(slotName, attachmentName); diff --git a/extensions/spine/Skeleton.js b/extensions/spine/Skeleton.js index 67dea2fa9a..c2197280fd 100644 --- a/extensions/spine/Skeleton.js +++ b/extensions/spine/Skeleton.js @@ -504,10 +504,13 @@ sp.Skeleton = cc.Class({ /** * !#en * Finds a bone by name. - * This does a string comparison for every bone. + * This does a string comparison for every bone.
+ * Returns a {{#crossLinkModule "spine"}}spine{{/crossLinkModule}}.Bone object. * !#zh * 通过名称查找 bone。 - * 这里对每个 bone 的名称进行了对比。 + * 这里对每个 bone 的名称进行了对比。
+ * 返回一个 {{#crossLinkModule "spine"}}spine{{/crossLinkModule}}.Bone 对象。 + * * @method findBone * @param {String} boneName * @return {spine.Bone} @@ -521,11 +524,12 @@ sp.Skeleton = cc.Class({ /** * !#en - * Finds a slot by name. - * This does a string comparison for every slot. + * Finds a slot by name. This does a string comparison for every slot.
+ * Returns a {{#crossLinkModule "spine"}}spine{{/crossLinkModule}}.Slot object. * !#zh - * 通过名称查找 slot。 - * 这里对每个 slot 的名称进行了比较。 + * 通过名称查找 slot。这里对每个 slot 的名称进行了比较。
+ * 返回一个 {{#crossLinkModule "spine"}}spine{{/crossLinkModule}}.Slot 对象。 + * * @method findSlot * @param {String} slotName * @return {spine.Slot} @@ -540,12 +544,14 @@ sp.Skeleton = cc.Class({ /** * !#en * Finds a skin by name and makes it the active skin. - * This does a string comparison for every skin. - * Note that setting the skin does not change which attachments are visible. + * This does a string comparison for every skin.
+ * Note that setting the skin does not change which attachments are visible.
+ * Returns a {{#crossLinkModule "spine"}}spine{{/crossLinkModule}}.Skin object. * !#zh - * 按名称查找皮肤,激活该皮肤。 - * 这里对每个皮肤的名称进行了比较。 - * 注意:设置皮肤不会改变 attachment 的可见性。。 + * 按名称查找皮肤,激活该皮肤。这里对每个皮肤的名称进行了比较。
+ * 注意:设置皮肤不会改变 attachment 的可见性。
+ * 返回一个 {{#crossLinkModule "spine"}}spine{{/crossLinkModule}}.Skin 对象。 + * * @method setSkin * @param {String} skinName * @return {spine.Skin} @@ -560,14 +566,16 @@ sp.Skeleton = cc.Class({ /** * !#en * Returns the attachment for the slot and attachment name. - * The skeleton looks first in its skin, then in the skeleton data’s default skin. + * The skeleton looks first in its skin, then in the skeleton data’s default skin.
+ * Returns a {{#crossLinkModule "spine"}}spine{{/crossLinkModule}}.Attachment object. * !#zh - * 通过 slot 和 attachment 的名称获取 attachment。 - * Skeleton 优先查找它的皮肤,然后才是 Skeleton Data 中默认的皮肤。 + * 通过 slot 和 attachment 的名称获取 attachment。Skeleton 优先查找它的皮肤,然后才是 Skeleton Data 中默认的皮肤。
+ * 返回一个 {{#crossLinkModule "spine"}}spine{{/crossLinkModule}}.Attachment 对象。 + * * @method getAttachment * @param {String} slotName * @param {String} attachmentName - * @return {spine.RegionAttachment|sp.spine.BoundingBoxAttachment} + * @return {spine.Attachment} */ getAttachment: function (slotName, attachmentName) { if (this._sgNode) { @@ -609,7 +617,7 @@ sp.Skeleton = cc.Class({ ///** // * Return the renderer of attachment. // * @method getTextureAtlas - // * @param {spine.RegionAttachment|sp.spine.BoundingBoxAttachment} regionAttachment + // * @param {spine.RegionAttachment|spine.BoundingBoxAttachment} regionAttachment // * @return {_ccsg.Node} // */ //getTextureAtlas: function (regionAttachment) { @@ -621,8 +629,10 @@ sp.Skeleton = cc.Class({ // ANIMATION /** - * !#en Sets animation state data. - * !#zh 设置动画状态数据。 + * !#en Sets animation state data.
+ * The parameter type is {{#crossLinkModule "spine"}}spine{{/crossLinkModule}}.AnimationStateData. + * !#zh 设置动画状态数据。
+ * 参数是 {{#crossLinkModule "spine"}}spine{{/crossLinkModule}}.AnimationStateData。 * @method setAnimationStateData * @param {spine.AnimationStateData} stateData */ @@ -662,8 +672,10 @@ sp.Skeleton = cc.Class({ }, /** - * !#en Set the current animation. Any queued animations are cleared. - * !#zh 设置当前动画。队列中的任何的动画将被清除。 + * !#en Set the current animation. Any queued animations are cleared.
+ * Returns a {{#crossLinkModule "spine"}}spine{{/crossLinkModule}}.TrackEntry object. + * !#zh 设置当前动画。队列中的任何的动画将被清除。
+ * 返回一个 {{#crossLinkModule "spine"}}spine{{/crossLinkModule}}.TrackEntry 对象。 * @method setAnimation * @param {Number} trackIndex * @param {String} name @@ -689,8 +701,10 @@ sp.Skeleton = cc.Class({ }, /** - * !#en Adds an animation to be played delay seconds after the current or last queued animation. - * !#zh 添加一个动画到动画队列尾部,还可以延迟指定的秒数。 + * !#en Adds an animation to be played delay seconds after the current or last queued animation.
+ * Returns a {{#crossLinkModule "spine"}}spine{{/crossLinkModule}}.TrackEntry object. + * !#zh 添加一个动画到动画队列尾部,还可以延迟指定的秒数。
+ * 返回一个 {{#crossLinkModule "spine"}}spine{{/crossLinkModule}}.TrackEntry 对象。 * @method addAnimation * @param {Number} trackIndex * @param {String} name @@ -706,8 +720,10 @@ sp.Skeleton = cc.Class({ }, /** - * !#en Returns track entry by trackIndex. - * !#zh 通过 track 索引获取 TrackEntry。 + * !#en Returns track entry by trackIndex.
+ * Returns a {{#crossLinkModule "spine"}}spine{{/crossLinkModule}}.TrackEntry object. + * !#zh 通过 track 索引获取 TrackEntry。
+ * 返回一个 {{#crossLinkModule "spine"}}spine{{/crossLinkModule}}.TrackEntry 对象。 * @method getCurrent * @param trackIndex * @return {spine.TrackEntry} diff --git a/extensions/spine/SkeletonData.js b/extensions/spine/SkeletonData.js index 37aba4712d..373fceae74 100644 --- a/extensions/spine/SkeletonData.js +++ b/extensions/spine/SkeletonData.js @@ -187,8 +187,10 @@ var SkeletonData = cc.Class({ }, /** - * !#en Get the included SkeletonData used in spine runtime. - * !#zh 获取 Spine Runtime 使用的 SkeletonData。 + * !#en Get the included SkeletonData used in spine runtime.
+ * Returns a {{#crossLinkModule "spine"}}spine{{/crossLinkModule}}.SkeletonData object. + * !#zh 获取 Spine Runtime 使用的 SkeletonData。
+ * 返回一个 {{#crossLinkModule "spine"}}spine{{/crossLinkModule}}.SkeletonData 对象。 * @method getRuntimeData * @param {Boolean} [quiet=false] * @return {spine.SkeletonData} diff --git a/extensions/spine/index.js b/extensions/spine/index.js index 24e2f04352..67d7db7569 100644 --- a/extensions/spine/index.js +++ b/extensions/spine/index.js @@ -124,3 +124,13 @@ if (!CC_EDITOR || !Editor.isMainProcess) { else { require('./SkeletonData'); } + +/** + * !#en + * `spine` is the namespace for official Spine Runtime, which officially implemented and maintained by Spine.
+ * Please refer to the official documentation for its detailed usage: [http://en.esotericsoftware.com/spine-using-runtimes](http://en.esotericsoftware.com/spine-using-runtimes) + * !#zh + * spine 模块是 Spine 官方运行库的 API 入口,由 Spine 官方统一实现和维护,具体用法请参考:[http://zh.esotericsoftware.com/spine-using-runtimes](http://zh.esotericsoftware.com/spine-using-runtimes) + * @module spine + * @main spine + */