Skip to content
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.

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

[FEATURE] need to support enum type #266

Closed
rdkmaster opened this issue Aug 5, 2017 · 7 comments
Closed

[FEATURE] need to support enum type #266

rdkmaster opened this issue Aug 5, 2017 · 7 comments

Comments

@rdkmaster
Copy link

Overview of the issue

take a look at the following picture,

default

PopupEffect is an enum type:

export enum PopupEffect {
    fadeIn, fadeOut, bubbleIn, bubbleOut
}

the source is here

compodoc do not create a link to it

Suggest a Fix

it it great to create a link to enum type

@vogloblinsky vogloblinsky changed the title [feature] need to support enum type [FEATURE] need to support enum type Aug 5, 2017
@vogloblinsky vogloblinsky added this to the 1.0.0-beta.14 milestone Aug 5, 2017
@eitanfr
Copy link

eitanfr commented Aug 6, 2017

  • 1
    also in my case, I have an enum in a sperate file and the documentation file isn't generated for it.

@kajnelissen
Copy link

Enumerations are listed on the Miscellaneous page @eitanfr . They do not have their own separate files like components et cetera.

@rdkmaster
Copy link
Author

@kajnelissen that's great, but it's much better if compodoc create a link ref to it

@eitanfr
Copy link

eitanfr commented Aug 8, 2017

@kajnelissen thx.
Is it possible to configure compodoc to create a separate page for enums? (or should I open another issue)
For example, I want to have the ability to search the enum docs by the enum name..

@vogloblinsky
Copy link
Contributor

@eitanfr
I have fixed this feature yesterday :

  • fixing the @link with enums, type aliases, variables and functions.
  • splitting the misc page in 4 pages : one for each : enums, type aliases, variables and functions.
    Coming very soon this week

@rdkmaster
Copy link
Author

@vogloblinsky thanks, I can't wait any longer for the next version

@lock
Copy link

lock bot commented Oct 1, 2019

This issue has been automatically locked due to inactivity. Please file a new issue if you are encountering a similar or related problem. Why locking ? Having issues with the most up-to-date context.

@lock lock bot locked as resolved and limited conversation to collaborators Oct 1, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

4 participants