afAxonDocsExt

A free extension for SkySpark to view Axon Documentation categorised for dot operator use.

Ever wondered what you can do with a Dict? Now you can click a button and find out!

Axon dot calls are great for piping the output of one function as the argument to another. But how many times have you typed a dot and been left wondering what function comes next!?

Axon Docs groups all Axon functions by their first argument type, and displays them neatly within SkySpark. Now you can click a data type and see all the functions you can use it with!

Axon Docs adds a new View to the Code app (and legacy Func app) within SkySpark.

More than that, you even select which libraries to show functions from, edit the data types functions are associated with, and import / export all your settings!

Axon Docs is a SkySpark extension requiring SkySpark v3.1 or later. For compatibility with SkySpark v3.0, download Axon Docs v0.2.

How it works

Axon Docs maintains a list of all Axon functions from all the extensions in your project and which data types they take for their first argument.

Clicking a Data type button performs a quick search on this list to find (and display) all matching functions.

With some Fantom based Axon functions, Axon Docs can make an educated guess as to what data types to associate it with. But for the most part it has been a manual process by Fantom Factory.

Use the Edit Funcs dialogue to change the data type assoication for the currently listed functions.

Note: The Edit Funcs dialogue does not edit or alter Axon functions, it only updates the internal Axon Docs database.

Settings Dialogue

The Settings Dialogue allows you to import and export the internal Axon Docs database. This way you can copy your customised Axon Docs settings from project to project, or from server to server.

Licence

Axon Docs is not open source, but it is free to use.

By using Axon Docs you agree to the End User Licence Agreement contained within the software.

Release Notes

v0.3.0

• Chg: Updated to be compatible with SkySpark v3.1.

v0.2.2

• Bug: Fixed an error when a documented func could not be found. Thanks to Simon Challet for reporting.

v0.2.0

• New: Created a whole new suite of function defaults for SkySpark v3.0.28+.
• New: AxonDocs View retains its settings whenever you nav away and come back.
• Chg: Disabled the aggregated (and fake) SysLib in SkySpark 3.0.28+.
• Bug: Funcs could be defined twice if defaults were known AND it was customised.

v0.1.4

• Chg: Dodgy user funcs no longer cause errors during initialisation / factory reset.

v0.1.2

• New: Axon Docs now integrates with the new SkySpark Code application.
• Chg: Added more obscure data types to the main button list.
• Chg: All core functions categorised to a data type.

v0.1.0

• New: First public release.