Skip to content

Typedoc API task generates non-public exports #2858

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

Closed
damyanpetev opened this issue Oct 29, 2018 · 0 comments
Closed

Typedoc API task generates non-public exports #2858

damyanpetev opened this issue Oct 29, 2018 · 0 comments
Assignees
Labels
📖 documentation 🧱 ci: build CI build related issues and PRs typedoc ✅ status: resolved Applies to issues that have pending PRs resolving them, or PRs that have already merged.

Comments

@damyanpetev
Copy link
Member

Description

Typedoc API task generates globals not exported through public_api.ts or in other words stuff that are not intended for user apps and can't be imported from 'igniteui-angular';.

I realize the typedoc generation was moved to the entire project folder for search purposes and we can go through and mark stuff @hidden. However, as you can see from the links below even on older prod deploys where non-public API is generated - the search is still iffy. Might not be related issues after all.

Steps to reproduce

Try some of the following links.

Note: This list is by no means exhaustive, just the few I noticed. There are prob way more using master.

Enums:
ExcelFileTypes (prod | staging)
ExcelFolderTypes (prod | staging)
ICON_POSITION staging

Classes:
AppFile (prod | staging)
CharSeparatedValueData (prod | staging)
ContentTypesFile (prod | staging)
DataGenerator staging
ExportUtilities (prod | staging)
HVirtualHelperComponent (prod | staging)
IgxAmPmItemDirective (prod | staging)
IgxComboAddItemDirective staging
IgxDialogActionsDirective (prod | staging)
IgxHourItemDirective (prod | staging)
MaskHelper (prod | staging)
IgxScrollInertiaDirective staging

Variables:
MASK_FLAGS (prod | staging)

Functions:
DeprecateClass, DeprecateMethod, DeprecateProperty

Object literals:
KEYS (prod | staging)

Result

Non public API is included in the generation.

Expected result

API pages should generate from public API only

@Aleksandyr Aleksandyr added the 🛠️ status: in-development Issues and PRs with active development on them label Nov 1, 2018
@Aleksandyr Aleksandyr added ✅ status: resolved Applies to issues that have pending PRs resolving them, or PRs that have already merged. and removed 🛠️ status: in-development Issues and PRs with active development on them labels Nov 1, 2018
bkulov pushed a commit that referenced this issue Jan 23, 2019
bkulov pushed a commit that referenced this issue Jan 23, 2019
bkulov added a commit that referenced this issue Jan 23, 2019
* chore(timepicker): Add typedoc comment for time picker directive (#2858)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📖 documentation 🧱 ci: build CI build related issues and PRs typedoc ✅ status: resolved Applies to issues that have pending PRs resolving them, or PRs that have already merged.
Projects
None yet
Development

No branches or pull requests

2 participants