Fat SWC ASDoc Support

From FDT Documentation

Jump to: navigation, search

Fat swc header.png

What makes a 'Fat' SWC special is that someone can compile generated HTML documentation (via ASDoc) into their SWCs. When used in FDT, this HTML formatted documentation becomes available within the editor.

Learn more about creating a 'Fat' SWC

Using Fat SWCs in FDT

To use Fat SWCs, you don't need to add or do anything special. When the SWC is added to your project, FDT will scan it, detect the documentation for you and make it available within the Editor and the ASDoc View

ASDoc In The Editor

Within the Editor, there are two ways of invoking ASDocs:

  • 1: Mousing over the keyword with the mouse.
  • 2: Autocompletion.

When you place the cursor over a keyword, after a brief pause FDT will display the ASDoc information. Asdoc hover.png

Documentation also appears when using autocompletion. No additional configuration is required. Fat swc.png

ASDoc View

Adoc header.png

Asdoc view.png

FDT also now includes an ASDoc View. This is a powerful and helpful view when working with Fat SWCs. Learn more about ASDoc View here.

Get FDT5