[eggPlant Functional] Useful SenseTalk Functions

Eggplant Examples
48

Here’s a couple of quick and dirty helpers, if you follow the EggDoc standards for comment (see EggDoc for details)…

getProp  summary
 return words 1 to -1 of second item delimited by "(**" \
   of second item delimited by "**)" of my script
end getProp

This second property is more detailed as should your EggDoc comments. It gives the parameters and their details as well.

getProp  usage
 return words 1 to -1 of second item delimited by "(**" \
   of first item delimited by "**)" of my script
end getProp

You can then sweep thru each object/script and the objects with a property of usage or summary that are not equal can be used to build a usage and summary table for your internal and external publication.

Here is an example of how to use the summary command for a Script called TempFileName, which returns a temp file in the file system with some powerful naming features included.

put TempFileName's summary

Enjoy!

1 Like