Skip to content

Support for @ignore? #198

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
grofit opened this issue Mar 23, 2016 · 7 comments
Closed

Support for @ignore? #198

grofit opened this issue Mar 23, 2016 · 7 comments
Labels
question Question about functionality

Comments

@grofit
Copy link

grofit commented Mar 23, 2016

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.
@vukmandavid
Copy link

It would be very useful. I tried exclude files, but in my case typedoc can't generate doc because missing references.

@enepomnyaschih
Copy link

enepomnyaschih commented Apr 23, 2016 •
edited
Loading

Did you try @hidden?

@grofit
Copy link
Author

grofit commented Apr 23, 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.

@enepomnyaschih
Copy link

Yeah, I was lucky to find this feature in source code.

@aciccarello aciccarello mentioned this issue Jan 18, 2017
Closed
@aciccarello
Copy link
Collaborator

Using @hidden should cover this use case but I think adding an alias to @ignore to match jsdoc would make sense.

@aciccarello aciccarello mentioned this issue Feb 3, 2017
Closed
@curioussavage
Copy link

it would also be nice if @hidden were documented on typedoc.org

@BurtHarris BurtHarris mentioned this issue Jun 7, 2017
Closed
@aciccarello aciccarello added enhancement question Question about functionality labels Jun 8, 2017
JDawes-ScottLogic added a commit to JDawes-ScottLogic/ContainerJS that referenced this issue Aug 3, 2017
@JDawes-ScottLogic
Add WindowOptions to docs
bbd5690 
Typedoc doesn't currently support @ignore - it uses @hidden. (See
TypeStrong/typedoc#198). Adding @hidden
alongside the @ignore correctly supresses the fin.WindowOptions, which
was generating invalid json (an array within an array for the child
property), and correctly creates the WindowOptions documentation.
@JDawes-ScottLogic JDawes-ScottLogic mentioned this issue Aug 3, 2017
Merged
JDawes-ScottLogic added a commit to JDawes-ScottLogic/ContainerJS that referenced this issue Aug 3, 2017
@JDawes-ScottLogic
Add WindowOptions to docs
5e03316 
Typedoc doesn't currently support @ignore - it uses @hidden. (See
TypeStrong/typedoc#198). Adding @hidden
alongside the @ignore correctly supresses the fin.WindowOptions, which
was generating invalid json (an array within an array for the child
property), and correctly creates the WindowOptions documentation.
JDawes-ScottLogic added a commit to symphonyoss/ContainerJS that referenced this issue Aug 3, 2017
@JDawes-ScottLogic
Add WindowOptions to docs (#325)
d956dec 
Typedoc doesn't currently support @ignore - it uses @hidden. (See
TypeStrong/typedoc#198). Adding @hidden
alongside the @ignore correctly supresses the fin.WindowOptions, which
was generating invalid json (an array within an array for the child
property), and correctly creates the WindowOptions documentation.
@aciccarello
Copy link
Collaborator

aciccarello commented Oct 27, 2017 •
edited
Loading

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:

  • Adding @ignore as an alias of @hidden
  • Document both options

@aciccarello aciccarello mentioned this issue Mar 5, 2018
Open
mrkurt pushed a commit to mrkurt/typedoc that referenced this issue Sep 19, 2018
@ice1080 @mrkurt
Add @ignore as an alias for @hidden (TypeStrong#750)
035a991 
closes TypeStrong#198
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
question Question about functionality
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: Implement @internal as synonym of @hidden BurtHarris/typedoc
6 participants
@enepomnyaschih @grofit @curioussavage @vukmandavid @aciccarello @Gerrit0