@@ -126,9 +126,12 @@ public static BasicExample Create(double x=42.0, double y=42.0, double z=42.0)
126126
127127 /// <summary>
128128 /// The MultiReturn attribute can be used to specify
129- /// the names of multiple output ports on a node that
130- /// returns a dictionary. The node must return a dictionary
131- /// to be recognized as a multi-out node.
129+ /// that a node is a multi-out node. This node must return
130+ /// a Dictionary with its keys matching the attributes specified in the
131+ /// MultiReturn attribute. The names of the output ports
132+ /// match the attribute names if there are no XML returns tags.
133+ /// The returned dictionary displayed in the node preview is displayed
134+ /// in the order of its keys as specified in the MultiReturn attribute.
132135 /// </summary>
133136 /// <returns></returns>
134137 [ MultiReturn ( new [ ] { "thing 1" , "thing 2" } ) ]
@@ -141,6 +144,30 @@ public static Dictionary<string, List<string>> MultiReturnExample()
141144 } ;
142145 }
143146
147+ /// <summary>
148+ /// The MultiReturn attribute can be used to specify
149+ /// that a node is a multi-out node. This node must return
150+ /// a Dictionary with its keys matching the attributes specified in the
151+ /// MultiReturn attribute. The names of the output ports
152+ /// match the XML returns tag only if they include descriptions.
153+ /// Otherwise the output ports will match the attribute names.
154+ /// The returned dictionary displayed in the node preview is displayed
155+ /// in the order of its keys as specified in the MultiReturn attribute.
156+ /// E.g. this node will display "thing1" and "thing2" in its output ports
157+ /// but it will show "thing 1" and "thing 2" in the node preview.
158+ /// </summary>
159+ /// <returns name="thing1">thing one</returns>
160+ /// <returns name="thing2">thing two</returns>
161+ [ MultiReturn ( new [ ] { "thing 1" , "thing 2" } ) ]
162+ public static Dictionary < string , List < string > > MultiReturnExample2 ( )
163+ {
164+ return new Dictionary < string , List < string > > ( )
165+ {
166+ { "thing 1" , new List < string > { "apple" , "banana" , "cat" } } ,
167+ { "thing 2" , new List < string > { "Tywin" , "Cersei" , "Hodor" } }
168+ } ;
169+ }
170+
144171 /// <summary>
145172 /// OPTIONAL:
146173 /// Overriding ToString allows you to control what is
0 commit comments