Getting Dox to ignore explicitly defined @private variables/methods

[Peter Stefcek]

Hi guys, I am not sure if this is possible. In JavaDoc we are able to define any variable or method as @private so it will be ignored by the documentation generator but running similarly tagged code through Dox will not omit them. Is this something not supported by Dox or is there a different tag for it? Is it something that can be easily added if its not supported out of the box? I used chxdoc a lot and even there I had to add it to support such explicitly defined private variables/methods, but since that project is abandoned I would like to switch to Dox. 

Any suggestions would be helpful thanks.

[Simon Krajewski]

I think it is something like @:dox(hide).

On 24 May 2014 19:18, "Peter Stefcek" <psh...@gmail.com> wrote:

Hi guys, I am not sure if this is possible. In JavaDoc we are able to define any variable or method as @private so it will be ignored by the documentation generator but running similarly tagged code through Dox will not omit them. Is this something not supported by Dox or is there a different tag for it? Is it something that can be easily added if its not supported out of the box? I used chxdoc a lot and even there I had to add it to support such explicitly defined private variables/methods, but since that project is abandoned I would like to switch to Dox. 

Any suggestions would be helpful thanks.

--
To post to this group haxe...@googlegroups.com
http://groups.google.com/group/haxelang?hl=en
---
You received this message because you are subscribed to the Google Groups "Haxe" group.
For more options, visit https://groups.google.com/d/optout.

[Peter Stefcek]

Thanks just tried but doesn't work for either variables or methods :(

[Jason O'Neil]

Hi Peter

It does work for me, in case there is confusion that is Haxe metadata Simon pointed out, not a documentation parameter.

For example, this works for me:

    @:dox(hide)
    public static function buildAFLViewForStudent(student:Student) {}

Hope that helps

[Peter Stefcek]

Do I need some specific run parameter for it to work? Since it simply doesn't work for me.

Here is the code:

http://prntscr.com/3n0rk0

Here is the generated xml, seems everything is allright:

http://prntscr.com/3n0rei

But its right there in the generated doc:

http://prntscr.com/3n0rhm

[Peter Stefcek]

Ok guys the problem was that I was installing dox using haxelib install dox which obviously contains some old sources. So installed it using haxelib git and it works as expected with the latest sources.

Thanks.