Hi!

So yeah I'm using Haxe and, while coding, code documentation doesn't display.
Things seem to work properly when using AS3, I can read class, member and method/param descriptions properly, but I only see the class, method or member name when using Haxe, no description. (yes, I did push F1 )

Is it a bug with FD 4.0.4, something I didn't configure properly, or a bug with Haxe compiler ? I can't even see the documentation I wrote myself in my Haxe classes, so it's not just the official Flash API.

Do you guys see the doc when using Haxe with FD ?

Thanks


Edit: I am using Haxe 2.10 and it's listed as Haxe SDK in FD's HaXeContext plugin. The Haxe doc is listed as html files in the Haxe\doc\content folder. Compilation works as well.

Edit 2: Actually when I use home made Haxe classes, I can't even get code completion. I do get it with official Flash API, though, but as I said no documentation here either.

Oh and I'm using Vista SP2 32 bits and FD 4.0.4 has been extracted as a standalone app. (Because I restore my system partition regularly)

I can see the docs with FD 4.0.4 and Haxe 2.10:


What completion mode are you using? (Tools -> Program Settings -> Haxe Context -> Completion Mode)
Do you get autocompletion with type inference? Try the following:

- Completion mode is "Compiler".

- When I type | from s.|, nothing happens.

- I do get home made classes descriptions actually, I had an error in the class I tried which prevented info from showing.
Official classes seem to work inconsistently, as shown below. (works for String but not Sprite nor Std)





- Even in AS3 projects, class description is not displayed. Say I type:

Classes listed after ":" or "new " don't have descriptions. All other descriptions work fine.


Finally, 2 issues slightly unrelated:
- I can't refactor->rename classes. I think it's always been like this in FD, but it would be nice if we could.
- Special characters (e.g. French accents) don't display properly in help description, but I suspect it's an issue with Haxe compiler because they work in AS3. (strange when you know Haxe's main developer is French )

Anyone has an idea ?

Haxe class Std, Iterator etc do have documentation in the Haxe folder, but FlashDevelop or Haxe compiler don't display it while coding. It's quite annoying :/

It doesn't display flash.display.Sprite either, among many others, but Sprite doesn't have doc in Haxe >_< (Although maybe, at least I hope so, the compiler or FD are supposed to compensate by displaying playerglobal.swc doc for classes contained in the flash and flash8 folders ?)

Also the lack of doc after "new " and ":" is problematic, but I think it's a missing feature and not a bug/misconfiguration you can help me sort out... ^^

Haxe classes don't contain much documentation themselves and Haxe NME just very recently included Flash doc for corresponding classes.

Most of the time, completion and doc is handled by the haxe compiler. In certain code situations however the compiler doesn't return any doc even if it should - these cases need to be identified and submitted to haxe's issue tracker.

When FD completion is involved (on specific occasions it kicks in) it should show the doc as well as in AS3, but there's no doc after "new " and ":" - this one's a old issue on FD side

Ok, thanks again

That's going to slow down Haxe development, having extensive doc showing in the IDE is handy.
Maybe I should install NME then, but I was willing to wait for it to mature first, like many people I think. Would it be worth it to have FD kick in and show Flex SDK doc for classes contained in flash and flash8 packages ? Since haxe compiler doesn't know where the Flex SDK is, only FD could do it. (or NME which I guess adds the appropriate flex doc to its own doc folders...)

Well ok I guess I should poke Haxe community too then =)

As I said, doc is provided by the haxe compiler, FD can't fix that automatically.

If you target Flash for the web you shouldn't use NME. Keep the AS3 language reference open in your browser

NME API was documented mostly automatically so I suppose it could be done for haxe too - you should try discussing it on haxe mailing list.

Heh ok, no NME for me then. I'll need to look for an Away3D 4 and/or Starling equivalent in Haxe for the web then, eventually =)

I moved to Haxe community to talk about this thread's issue. Thanks! (3rd time)