ASDoc
From FDT Documentation
Whenever the code in your project has ASDoc notation, FDT will read it and display it both in the ASDoc View and in the editor. This is perhaps one of our most voted features.
Learn more about creating ASDoc notation
Contents |
Video
Showing ASDoc View
Window Menu
If your ASDoc View isn't already visible you can add it via Window>Show View>Other>FDT>ASDoc View.
ASDoc Icon
You can also open the ASDoc view by clicking on the ASDoc icon at the bottom on the ASDoc popup.
Keyboard & Mouse
Still another way is to open it using your keyboard and mouse. The default keystroke to show the view is CTRL+SHIFT+F1.
Another powerful feature of the ASDoc view is being able to jump to the source file which the ASDoc View is referencing. This can be easily done by clicking on the 'open declaration' icon at the bottom of the ASDoc View.
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.
Documentation also appears when using autocompletion. No additional configuration is required.