SFS2X Docs / ExtensionsJava / using-javadoc
» How to use the server-side Javadoc
Once you have experimented with a basic Extension, as introduced in the quick start chapter, you can consult the server-side Javadoc to explore the features of the server API and get a reference for the available methods.
The starting point for accessing the server API is the SFSApi class, which is accessible from within the main Extension class and in any request/event handler via the getApi() method.
» Java IDE integration
You can also install a local copy of the Javadoc in your IDE of choice to integrate it with the auto-completion feature. You can find the updated version of the Javadoc here.
Once you've downloaded the zip file you can follow these instructions to install it in your IDE.
To install the documentation in the Eclipse IDE follow these steps:
- Right-click your SFS2X Extension project and select Properties
- Select Java Build Path from the left hand menu
- Select the Libraries tab in the right hand panel
- Select the sfs2x.jar file and click the little arrow next to it
- Double click the Javadoc location option and select the zipped javadoc file from your disk.
To install the documentation in the IntelliJ Idea IDE follow these steps:
- Right-click your SFS2X Extension project and click Open Module Settings
- Select the Modules option from the left hand menu
- Select the module containing the SmartFox jars
- Select the Dependencies tab
- Select the jar/library and click the Edit icon at the bottom
- Finally click the Add (+) icon and add the javadoc zip
To install the documentation in the Netbeans IDE follow these steps:
- Right-click your SFS2X Extension project
- Click on Libraries from the left hand menu
- Select the Compile tab from the panel on the right side
- Select the sfs2x.jar and click the Edit button on the right side
- In the Javadoc field point to the javadoc zip file from your disk