${type} breaks with inline structure declarations

[Gama11]

By default, codedox puts the returned type after @return:

However, when returning a structure, the return is missing:

class Main {
	public static function main() {}

	public function foo():{x:Int, y:Int} {
		return {x:0, y:0};
	}
}

The situation with @param is similar, once you configure codedox to use $type{} there:

class Main {
	public static function main() {}
	
	public function foo(point:{x:Int, y:Int}) {
		trace(point);
	}
}

[wiggin77]

I am looking at replacing my current regex-based function parsing with Simn's haxeparser. That should help deal with these scenarios.

Any thoughts on what should go in the comment? Outputting the whole struct definition there?

[Gama11]

It should probably be the whole definition, since that's what the "type" is. In practice, you probably wouldn't want that (well, personally I wouldn't use ${type} for @param docs anyway) or use a typedef to begin with.

Note that with haxeparser, you will start to run into issues with conditional compilation - it behaves exactly like the Haxe compiler's parser, in that it throws away any #if blocks that are not active. It should still be more solid than what you currently have though. :)

[Gama11]

And of course, the file actually needs to be parsable (which might not always be the case in a code editor context).

We need something that can a) deal with conditional compilation and b) is error robust as well for vshaxe eventually - @nadako has started working on something for that: https://github.com/nadako/crazyparser (not usable yet afaik)

[wiggin77]

I did run into the "code has to be parsable" issue already. So now I'm experimenting with extracting just the function to be documented, inserting that into a phony class declaration, and give that to the parser (since it does no seem to expose any ability to parse parts of documents).

If that fails parsing because the function is body is not valid yet then I will then replace the function body with something bogus and lose the ability to determine return type when not specified in the signature.

Thanks for the heads up on the #if issue.
We'll see how it goes.