add markers for doc generation of teleport macros

data/core/macros/teleport-utils.cfg

@@ -41,6 +41,13 @@
 #enddef
 
 #define TELEPORT_OUT_ANIMATION
+    # Generalized silver mage teleport out (disappear) animation
+    #
+    # For example, to apply a teleport animation to a custom unit definition:
+    #![animation]
+    #!    apply_to=pre_teleport
+    #!    {TELEPORT_OUT_ANIMATION}
+    #![/animation]
 
             start_time=-1200
 
@@ -114,6 +121,13 @@
 #enddef
 
 #define TELEPORT_IN_ANIMATION
+    # Generalized silver mage teleport in (reappear) animation
+    #
+    # For example, to apply a teleport animation to a custom unit definition:
+    #![animation]
+    #!    apply_to=post_teleport
+    #!    {TELEPORT_IN_ANIMATION}
+    #![/animation]
 
         	start_time=-1200
 
@@ -185,7 +199,13 @@
         	[/frame]
 #enddef
 
+
 #define TELEPORT_EFFECT_OBJECT_ID _ID_
+    # Creates and assigns a temporary object which applies the generalized silver mage 
+    # teleport animations to the unit with the matching ID 
+    #
+    # For example, to apply teleport animations to the unit 'Bob':
+    #!{TELEPORT_EFFECT_OBJECT_ID Bob}
 
 [object]
     silent=yes
@@ -213,9 +233,15 @@
 #enddef
 
 #define TELEPORT_EFFECT_OBJECT
+    # Creates and assigns a temporary object which applies the generalized silver mage 
+    # teleport animations to the primary unit 
+    #
+    # For example, to apply teleport animations to the unit that triggered a 'move_to' event:
+    #!{TELEPORT_EFFECT_OBJECT}
+
 [object]
     silent=yes
-    duration=turn
+    duration=level	#should be "turn" once support is implemented
 
     [effect]
         apply_to=new_animation
@@ -232,4 +258,3 @@
 	[/effect]
 [/object]
 #enddef
-