I assume that the syntax typedoc uses is based off jsdoc, but I have noticed that it doesn't support all the common features, in this instance the @ignore option which should omit the related variable/class/property etc from the documentation.
grofit
All 7 comments
It would be very useful. I tried exclude files, but in my case typedoc can't generate doc because missing references.
vukmandavid
on 24 Mar 2016
Did you try @hidden?
enepomnyaschih
on 23 Apr 2016
nope, will try that when I am back on the project. I find it odd though that in some areas it followed jsdoc and in others it just does its own thing.
grofit
on 23 Apr 2016
Yeah, I was lucky to find this feature in source code.
enepomnyaschih
on 24 Apr 2016
Using @hidden should cover this use case but I think adding an alias to @ignore to match jsdoc would make sense.
aciccarello
on 3 Feb 2017
it would also be nice if @hidden were documented on typedoc.org
curioussavage
on 15 Mar 2017
Reviewing this, I think it would be good to alias JSDoc's @ignore option to TypeDoc's @hidden. As far as I can tell they both do the same thing. The action steps needed are:
- [x] Adding
@ignoreas an alias of@hidden - [x] Document both options
aciccarello
on 27 Oct 2017
Related issues
3nsoft
路
3Comments
Rycochet
路
4Comments
KevinEady
路
3Comments
pushkov-fedor
路
3Comments
topherfangio
路
3Comments
Most helpful comment
Using
@hiddenshould cover this use case but I think adding an alias to@ignoreto match jsdoc would make sense.