Howdy, Stranger!
It looks like you're new here. If you want to get involved, click one of these buttons!
Quick Links
Categories
- 7.8K All Categories
- 11 Help with translations
- 4.2K General questions
- 107 Roadmap
- 358 Game & application design
- 315 Plugins
- 70 User experience
- 75 Marketplace
- 290 Code snippets
- 34 Building a team?
- 269 Suggestions & requests
- 352 Announce your apps made with Gideros.
- 90 Step by step tutorials
- 668 Bugs and issues
- 195 Introduce yourself
- 239 Announcements
- 106 Forum talk
- 404 Relax cafe
In this Discussion
Add API Docs to IDE
flyingaudio
Member
Your IDE is almost complete. It just needs thorough API docs and a Visual Debugger.
Make it so easy/enjoyable for people to code, that they will be drawn to your solution.
Example: When typing just the first letter (not first two), show what Lua and Gideros commands are available. Also, show somewhere else the details, with example(s), on how to implement that command. This could be shown in some other panel, and would allow you to have the API docs at your finger tips.
You already have the API document, just display it within the IDE.
Note: I have found the documentation weak; i.e., no examples and no listings of what the options are on required parameters. For instance, "EventDispatcher:addEventListener(type, listener, data)", shows TYPE as STRING, which is almost useless, since I need to know what the string is, like, "click", "touch", "tap", "touches", "begin", "end", "move", whatever it might be for an API.
If this existed in your IDE, it would be a dream to code. The weak docs is one of the reasons I haven't adopted your SDK yet. I don't want to hunt for everything, and even when I do look at the API Docs, it still doesn't give me everything I need to know, without digging for them. I am not here to dig, but to code. I am comfortable with another SDK, so the easier you can make it for me to play with yours the better.
You have many strengths going for you, which I cannot ignore, especially the testing directly on the device, awesome!!! Offline project builds, awesome!!!, and IDE, awesome!!!
With docs integrated into the IDE and Visual Debugging, it would almost be a must, except that I do need audio recording for my next project, and preferably local notifications. I could actually skip the audio recording for the first version. I guess it is the easy access to thorough docs that I really want.
Make it so easy/enjoyable for people to code, that they will be drawn to your solution.
Example: When typing just the first letter (not first two), show what Lua and Gideros commands are available. Also, show somewhere else the details, with example(s), on how to implement that command. This could be shown in some other panel, and would allow you to have the API docs at your finger tips.
You already have the API document, just display it within the IDE.
Note: I have found the documentation weak; i.e., no examples and no listings of what the options are on required parameters. For instance, "EventDispatcher:addEventListener(type, listener, data)", shows TYPE as STRING, which is almost useless, since I need to know what the string is, like, "click", "touch", "tap", "touches", "begin", "end", "move", whatever it might be for an API.
If this existed in your IDE, it would be a dream to code. The weak docs is one of the reasons I haven't adopted your SDK yet. I don't want to hunt for everything, and even when I do look at the API Docs, it still doesn't give me everything I need to know, without digging for them. I am not here to dig, but to code. I am comfortable with another SDK, so the easier you can make it for me to play with yours the better.
You have many strengths going for you, which I cannot ignore, especially the testing directly on the device, awesome!!! Offline project builds, awesome!!!, and IDE, awesome!!!
With docs integrated into the IDE and Visual Debugging, it would almost be a must, except that I do need audio recording for my next project, and preferably local notifications. I could actually skip the audio recording for the first version. I guess it is the easy access to thorough docs that I really want.
Likes: atilim
Tagged:
+1 -1 (+1 / -0 )Share on Facebook
Comments
http://bugs.giderosmobile.com/issues/61
http://bugs.giderosmobile.com/issues/62
The first and most important issue is due Gideros Studio 2012.2.4, 3 versions later. IDE debugger is due the next major release, in summer.
The intellij idea lua plugin does luadoc by pressing --- and then enter over the function.