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

Make JSDoc @description tags available on more reflection classes and types #463

Merged
merged 1 commit into from
Oct 1, 2023

Conversation

jefflaporte
Copy link
Contributor

Summary of changes

Expands support for jsDoc @description info, on classes, methods, functions, enums, interfaces, and type aliases. This was needed for an unreleased project I'm working on.

Changes are in type/src/reflection/ and type-compiler/src/compiler.ts.
Tests have been added in packages/type/tests/jsdoc.spec.ts.

Thanks to the Deepkit team for the amazing project!

Relinquishment of Rights

Please mark following checkbox to confirm that you relinquish all rights of your changes:

  • I waive and relinquish all rights regarding this changes (including code, text, and images) to Deepkit UG (limited), Germany. This changes (including code, text, and images) are under MIT license without name attribution, copyright notice, and permission notice requirement.

@jefflaporte jefflaporte changed the title Make jsDoc @description tags available on more reflection classes and types Make JSDoc @description tags available on more reflection classes and types Jul 21, 2023
@codecov-commenter
Copy link

codecov-commenter commented Jul 22, 2023

Codecov Report

Merging #463 (b97b867) into master (3fd48ea) will increase coverage by 0.01%.
The diff coverage is 66.66%.

❗ Current head b97b867 differs from pull request most recent head dbab73e. Consider uploading reports for the commit dbab73e to get more accurate results

❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.

@@            Coverage Diff             @@
##           master     #463      +/-   ##
==========================================
+ Coverage   78.37%   78.38%   +0.01%     
==========================================
  Files         173      173              
  Lines       18538    18547       +9     
  Branches     4843     4845       +2     
==========================================
+ Hits        14529    14538       +9     
  Misses       4009     4009              
Impacted Files Coverage Δ
packages/type/src/reflection/type.ts 83.28% <ø> (+0.27%) ⬆️
packages/type/src/reflection/reflection.ts 69.42% <66.66%> (-0.04%) ⬇️

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@marcj marcj merged commit 8aee9a1 into deepkit:master Oct 1, 2023
5 checks passed
@marcj
Copy link
Member

marcj commented Oct 1, 2023

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants