Differences
This shows you the differences between two versions of the page.
phantm:apis [2010/05/04 15:23] ekneuss created |
phantm:apis [2010/05/04 15:37] (current) ekneuss |
||
---|---|---|---|
Line 1: | Line 1: | ||
===== APIs ===== | ===== APIs ===== | ||
- | ''phantm'' supports external API files in XML format. For example, all internal functions, classes and constants are defined using such an API file. Not only it can import those files, but it can also generate them. | + | //phantm// supports external API files in XML format. For example, all internal functions, classes and constants are defined using such an API file. Not only it can import those files, but it can also generate them. |
==== Importing API ==== | ==== Importing API ==== | ||
Line 10: | Line 10: | ||
==== Exporting API ==== | ==== Exporting API ==== | ||
- | ''phantm'' will be able to generate a plausible API for your functons, by collecting types on all call-sites and generating possible requirements for its arguments and return values. | + | //phantm// will be able to generate a plausible API for your functons, by collecting types on all call-sites and generating possible requirements for its arguments and return values. |
To generate such an API, use the %%--exportAPI%% followed by the path to the file you wish to store the API. | To generate such an API, use the %%--exportAPI%% followed by the path to the file you wish to store the API. | ||