Skip to content

Changed (IBasicFilter | IAdvancedFilter) to IFilter#39

Merged
mattmazzola merged 2 commits into
devfrom
wabreza/ifilter-refactor
Aug 30, 2016
Merged

Changed (IBasicFilter | IAdvancedFilter) to IFilter#39
mattmazzola merged 2 commits into
devfrom
wabreza/ifilter-refactor

Conversation

@wbreza
Copy link
Copy Markdown
Contributor

@wbreza wbreza commented Aug 30, 2016

No description provided.

@msftclas msftclas added the documentation Improvements or additions to documentation label Aug 30, 2016
Comment thread gulpfile.js Outdated
gulp.task("docs", 'Compile documentation from src code', function () {
return gulp
.src(["src/**/*.ts"])
.src(["typings/globals/es6-promise/index.d.ts", "src/**/*.ts"])
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This allows the typedoc to generate docs with Promise

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is unrelated to changing filter types / interfaces though.

Would rather fix typedoc in separate PR with all of the needed .d.ts files.
I assume it needs all the dependent libraries, perhaps just include all typings folder.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Big reason for updating to IFilter was to support typedoc. Typedoc doesn't support the (A|B) syntax. If we include all the typings then it will generate docs for dev dependencies like jasmine, etc.

Copy link
Copy Markdown
Contributor

@mattmazzola mattmazzola Aug 30, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It sounds like there are two different issues here.

  1. Typedoc doesn't support union types
  2. External .d.ts files need to be included
    (es6-promise, wpmp, hpm, router, models)

If true, the second issue is independent. Or is 2 a non-issue and typedoc already handles this?

@mattmazzola mattmazzola merged commit bded8a0 into dev Aug 30, 2016
@mattmazzola mattmazzola deleted the wabreza/ifilter-refactor branch August 30, 2016 22:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants