Java documentation variable names

[Hassan Khallouf]

Hello everyone,
I find it very annoying that the variable names in the java api for server side scripting don't appear like their docs in web, for example:
the function createRoom in ISFSApi has this signature in documents

Code: Select all

createRoom(Zone zone, CreateRoomSettings settings, User owner, boolean joinIt, Room roomToLeave, boolean fireClientEvent, boolean fireServerEvent)

but in my IDE (I use intellij) this is the sigature that appear in IntelliSense:

Code: Select all

   createRoom(Zone zone, CreateRoomSettings settings, User user, boolean b, Room room, boolean b1, boolean b2)

this is very confusing, I need to refer to the web docs almost every time I want to use an api method, what's the first boolean is for? is fireClientEvent boolean or fireServerEvent first?

am I missing something in my installation ?

[Lapo]

Hi,
the fact is that variable names are not included in the jar file, so the IDE auto-generates them based on custom logic. Typically what the IDE does is simply to create a lower case variable name with the same name of the variable type.

Such as:

Code: Select all

Room room
User user
boolean b
int i
double d
etc...

In any case you can get the javadoc jar from here, and add it to your IDE so that you have integrated docs. The IDE will still make up the variable names but at least you'll have a reference handy.

Hope it helps

[Hassan Khallouf]

thanks lapo
it worked, although as you said, I need to call upon the help using F1 to get the documentation, I'm more used to Visual Studio, it actually pulls the var names from the docs if they are available

I ended up linking the module to the docs link instead of using the zip you gave me (both worked)
http://docs2x.smartfoxserver.com/api-do ... oc/server/