From f5b72c62cf30a4d8c0d5b5519e7ccd230bfe466f Mon Sep 17 00:00:00 2001 From: Mario Zechner Date: Mon, 20 Jun 2022 16:42:56 +0200 Subject: [PATCH] [godot] Added in-editor doc scafolds. --- spine-godot/spine_godot/config.py | 35 +- .../spine_godot/docs/SpineAnimation.xml | 53 +++ .../spine_godot/docs/SpineAnimationState.xml | 106 ++++++ .../spine_godot/docs/SpineAnimationTrack.xml | 65 ++++ .../spine_godot/docs/SpineAtlasResource.xml | 27 ++ .../spine_godot/docs/SpineAttachment.xml | 23 ++ spine-godot/spine_godot/docs/SpineBone.xml | 357 ++++++++++++++++++ .../spine_godot/docs/SpineBoneData.xml | 149 ++++++++ .../spine_godot/docs/SpineBoneNode.xml | 23 ++ .../spine_godot/docs/SpineConstraintData.xml | 40 ++ spine-godot/spine_godot/docs/SpineEvent.xml | 78 ++++ .../spine_godot/docs/SpineIkConstraint.xml | 110 ++++++ .../docs/SpineIkConstraintData.xml | 95 +++++ .../spine_godot/docs/SpinePathConstraint.xml | 110 ++++++ .../docs/SpinePathConstraintData.xml | 128 +++++++ .../spine_godot/docs/SpineSkeleton.xml | 207 ++++++++++ .../docs/SpineSkeletonDataResource.xml | 187 +++++++++ .../docs/SpineSkeletonFileResource.xml | 13 + spine-godot/spine_godot/docs/SpineSkin.xml | 79 ++++ spine-godot/spine_godot/docs/SpineSlot.xml | 99 +++++ .../spine_godot/docs/SpineSlotData.xml | 83 ++++ .../spine_godot/docs/SpineSlotNode.xml | 23 ++ spine-godot/spine_godot/docs/SpineSprite.xml | 162 ++++++++ .../spine_godot/docs/SpineTimeline.xml | 55 +++ .../spine_godot/docs/SpineTrackEntry.xml | 261 +++++++++++++ .../docs/SpineTransformConstraint.xml | 116 ++++++ .../docs/SpineTransformConstraintData.xml | 93 +++++ 27 files changed, 2776 insertions(+), 1 deletion(-) create mode 100644 spine-godot/spine_godot/docs/SpineAnimation.xml create mode 100644 spine-godot/spine_godot/docs/SpineAnimationState.xml create mode 100644 spine-godot/spine_godot/docs/SpineAnimationTrack.xml create mode 100644 spine-godot/spine_godot/docs/SpineAtlasResource.xml create mode 100644 spine-godot/spine_godot/docs/SpineAttachment.xml create mode 100644 spine-godot/spine_godot/docs/SpineBone.xml create mode 100644 spine-godot/spine_godot/docs/SpineBoneData.xml create mode 100644 spine-godot/spine_godot/docs/SpineBoneNode.xml create mode 100644 spine-godot/spine_godot/docs/SpineConstraintData.xml create mode 100644 spine-godot/spine_godot/docs/SpineEvent.xml create mode 100644 spine-godot/spine_godot/docs/SpineIkConstraint.xml create mode 100644 spine-godot/spine_godot/docs/SpineIkConstraintData.xml create mode 100644 spine-godot/spine_godot/docs/SpinePathConstraint.xml create mode 100644 spine-godot/spine_godot/docs/SpinePathConstraintData.xml create mode 100644 spine-godot/spine_godot/docs/SpineSkeleton.xml create mode 100644 spine-godot/spine_godot/docs/SpineSkeletonDataResource.xml create mode 100644 spine-godot/spine_godot/docs/SpineSkeletonFileResource.xml create mode 100644 spine-godot/spine_godot/docs/SpineSkin.xml create mode 100644 spine-godot/spine_godot/docs/SpineSlot.xml create mode 100644 spine-godot/spine_godot/docs/SpineSlotData.xml create mode 100644 spine-godot/spine_godot/docs/SpineSlotNode.xml create mode 100644 spine-godot/spine_godot/docs/SpineSprite.xml create mode 100644 spine-godot/spine_godot/docs/SpineTimeline.xml create mode 100644 spine-godot/spine_godot/docs/SpineTrackEntry.xml create mode 100644 spine-godot/spine_godot/docs/SpineTransformConstraint.xml create mode 100644 spine-godot/spine_godot/docs/SpineTransformConstraintData.xml diff --git a/spine-godot/spine_godot/config.py b/spine-godot/spine_godot/config.py index 827e2c435..689c91499 100644 --- a/spine-godot/spine_godot/config.py +++ b/spine-godot/spine_godot/config.py @@ -2,4 +2,37 @@ def can_build(env, platform): return True def configure(env): - pass \ No newline at end of file + pass + +def get_doc_path(): + return "docs" + +def get_doc_classes(): + return [ + "SpineAnimation", + "SpineAnimationState", + "SpineAnimationTrack", + "SpineAtlasResource", + "SpineAttachment", + "SpineBone", + "SpineBoneData", + "SpineBoneNode", + "SpineConstraintData", + "SpineEvent", + "SpineIkConstraint", + "SpineIkConstraintData", + "SpinePathConstraint", + "SpinePathConstraintData", + "SpineSkeleton", + "SpineSkeletonDataResource", + "SpineSkeletonFileResource", + "SpineSkin", + "SpineSlot", + "SpineSlotData", + "SpineSlotNode", + "SpineSprite", + "SpineTimeline", + "SpineTrackEntry", + "SpineTransformConstraint", + "SpineTransformConstraintData" + ] diff --git a/spine-godot/spine_godot/docs/SpineAnimation.xml b/spine-godot/spine_godot/docs/SpineAnimation.xml new file mode 100644 index 000000000..fb378f0f6 --- /dev/null +++ b/spine-godot/spine_godot/docs/SpineAnimation.xml @@ -0,0 +1,53 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/spine-godot/spine_godot/docs/SpineAnimationState.xml b/spine-godot/spine_godot/docs/SpineAnimationState.xml new file mode 100644 index 000000000..c221e3807 --- /dev/null +++ b/spine-godot/spine_godot/docs/SpineAnimationState.xml @@ -0,0 +1,106 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/spine-godot/spine_godot/docs/SpineAnimationTrack.xml b/spine-godot/spine_godot/docs/SpineAnimationTrack.xml new file mode 100644 index 000000000..cb27ba716 --- /dev/null +++ b/spine-godot/spine_godot/docs/SpineAnimationTrack.xml @@ -0,0 +1,65 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/spine-godot/spine_godot/docs/SpineAtlasResource.xml b/spine-godot/spine_godot/docs/SpineAtlasResource.xml new file mode 100644 index 000000000..7e46042af --- /dev/null +++ b/spine-godot/spine_godot/docs/SpineAtlasResource.xml @@ -0,0 +1,27 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/spine-godot/spine_godot/docs/SpineAttachment.xml b/spine-godot/spine_godot/docs/SpineAttachment.xml new file mode 100644 index 000000000..6a9b01667 --- /dev/null +++ b/spine-godot/spine_godot/docs/SpineAttachment.xml @@ -0,0 +1,23 @@ + + + + + + + + + + + + + + + + + + + + + + + diff --git a/spine-godot/spine_godot/docs/SpineBone.xml b/spine-godot/spine_godot/docs/SpineBone.xml new file mode 100644 index 000000000..b8f5f5cf6 --- /dev/null +++ b/spine-godot/spine_godot/docs/SpineBone.xml @@ -0,0 +1,357 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/spine-godot/spine_godot/docs/SpineBoneData.xml b/spine-godot/spine_godot/docs/SpineBoneData.xml new file mode 100644 index 000000000..64703d0cc --- /dev/null +++ b/spine-godot/spine_godot/docs/SpineBoneData.xml @@ -0,0 +1,149 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/spine-godot/spine_godot/docs/SpineBoneNode.xml b/spine-godot/spine_godot/docs/SpineBoneNode.xml new file mode 100644 index 000000000..2b517c989 --- /dev/null +++ b/spine-godot/spine_godot/docs/SpineBoneNode.xml @@ -0,0 +1,23 @@ + + + + + + + + + + + + + + + + + + + + + + + diff --git a/spine-godot/spine_godot/docs/SpineConstraintData.xml b/spine-godot/spine_godot/docs/SpineConstraintData.xml new file mode 100644 index 000000000..83940010e --- /dev/null +++ b/spine-godot/spine_godot/docs/SpineConstraintData.xml @@ -0,0 +1,40 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/spine-godot/spine_godot/docs/SpineEvent.xml b/spine-godot/spine_godot/docs/SpineEvent.xml new file mode 100644 index 000000000..798bbbece --- /dev/null +++ b/spine-godot/spine_godot/docs/SpineEvent.xml @@ -0,0 +1,78 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/spine-godot/spine_godot/docs/SpineIkConstraint.xml b/spine-godot/spine_godot/docs/SpineIkConstraint.xml new file mode 100644 index 000000000..0a669642d --- /dev/null +++ b/spine-godot/spine_godot/docs/SpineIkConstraint.xml @@ -0,0 +1,110 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/spine-godot/spine_godot/docs/SpineIkConstraintData.xml b/spine-godot/spine_godot/docs/SpineIkConstraintData.xml new file mode 100644 index 000000000..b794c10a5 --- /dev/null +++ b/spine-godot/spine_godot/docs/SpineIkConstraintData.xml @@ -0,0 +1,95 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/spine-godot/spine_godot/docs/SpinePathConstraint.xml b/spine-godot/spine_godot/docs/SpinePathConstraint.xml new file mode 100644 index 000000000..3c6d3e456 --- /dev/null +++ b/spine-godot/spine_godot/docs/SpinePathConstraint.xml @@ -0,0 +1,110 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/spine-godot/spine_godot/docs/SpinePathConstraintData.xml b/spine-godot/spine_godot/docs/SpinePathConstraintData.xml new file mode 100644 index 000000000..0b3595c57 --- /dev/null +++ b/spine-godot/spine_godot/docs/SpinePathConstraintData.xml @@ -0,0 +1,128 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/spine-godot/spine_godot/docs/SpineSkeleton.xml b/spine-godot/spine_godot/docs/SpineSkeleton.xml new file mode 100644 index 000000000..a16c6819c --- /dev/null +++ b/spine-godot/spine_godot/docs/SpineSkeleton.xml @@ -0,0 +1,207 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/spine-godot/spine_godot/docs/SpineSkeletonDataResource.xml b/spine-godot/spine_godot/docs/SpineSkeletonDataResource.xml new file mode 100644 index 000000000..114b1e2b1 --- /dev/null +++ b/spine-godot/spine_godot/docs/SpineSkeletonDataResource.xml @@ -0,0 +1,187 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/spine-godot/spine_godot/docs/SpineSkeletonFileResource.xml b/spine-godot/spine_godot/docs/SpineSkeletonFileResource.xml new file mode 100644 index 000000000..74e26e7f1 --- /dev/null +++ b/spine-godot/spine_godot/docs/SpineSkeletonFileResource.xml @@ -0,0 +1,13 @@ + + + + + + + + + + + + + diff --git a/spine-godot/spine_godot/docs/SpineSkin.xml b/spine-godot/spine_godot/docs/SpineSkin.xml new file mode 100644 index 000000000..abcde9e8f --- /dev/null +++ b/spine-godot/spine_godot/docs/SpineSkin.xml @@ -0,0 +1,79 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/spine-godot/spine_godot/docs/SpineSlot.xml b/spine-godot/spine_godot/docs/SpineSlot.xml new file mode 100644 index 000000000..3d31cef23 --- /dev/null +++ b/spine-godot/spine_godot/docs/SpineSlot.xml @@ -0,0 +1,99 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/spine-godot/spine_godot/docs/SpineSlotData.xml b/spine-godot/spine_godot/docs/SpineSlotData.xml new file mode 100644 index 000000000..86b70bc85 --- /dev/null +++ b/spine-godot/spine_godot/docs/SpineSlotData.xml @@ -0,0 +1,83 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/spine-godot/spine_godot/docs/SpineSlotNode.xml b/spine-godot/spine_godot/docs/SpineSlotNode.xml new file mode 100644 index 000000000..94e276ded --- /dev/null +++ b/spine-godot/spine_godot/docs/SpineSlotNode.xml @@ -0,0 +1,23 @@ + + + + + + + + + + + + + + + + + + + + + + + diff --git a/spine-godot/spine_godot/docs/SpineSprite.xml b/spine-godot/spine_godot/docs/SpineSprite.xml new file mode 100644 index 000000000..5ba3b017b --- /dev/null +++ b/spine-godot/spine_godot/docs/SpineSprite.xml @@ -0,0 +1,162 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/spine-godot/spine_godot/docs/SpineTimeline.xml b/spine-godot/spine_godot/docs/SpineTimeline.xml new file mode 100644 index 000000000..31f3ccfd1 --- /dev/null +++ b/spine-godot/spine_godot/docs/SpineTimeline.xml @@ -0,0 +1,55 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/spine-godot/spine_godot/docs/SpineTrackEntry.xml b/spine-godot/spine_godot/docs/SpineTrackEntry.xml new file mode 100644 index 000000000..142b8d303 --- /dev/null +++ b/spine-godot/spine_godot/docs/SpineTrackEntry.xml @@ -0,0 +1,261 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/spine-godot/spine_godot/docs/SpineTransformConstraint.xml b/spine-godot/spine_godot/docs/SpineTransformConstraint.xml new file mode 100644 index 000000000..b90c68a9f --- /dev/null +++ b/spine-godot/spine_godot/docs/SpineTransformConstraint.xml @@ -0,0 +1,116 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/spine-godot/spine_godot/docs/SpineTransformConstraintData.xml b/spine-godot/spine_godot/docs/SpineTransformConstraintData.xml new file mode 100644 index 000000000..6cec6fe99 --- /dev/null +++ b/spine-godot/spine_godot/docs/SpineTransformConstraintData.xml @@ -0,0 +1,93 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +