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.

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

Input properties defined using the setter/getter are not properly documented #14770

Closed
lukasmatta opened this issue Feb 8, 2024 · 0 comments · Fixed by #14771
Closed

Input properties defined using the setter/getter are not properly documented #14770

lukasmatta opened this issue Feb 8, 2024 · 0 comments · Fixed by #14771
Labels
Component: Documentation Issue or pull request is related to Documentation Type: Bug Issue contains a bug related to a specific component. Something about the component is not working
Milestone
17.13.0

Comments

@lukasmatta
Copy link
Contributor

lukasmatta commented Feb 8, 2024 •
edited
Loading

Describe the bug

Due to a problem in the build-apidoc.ts script, description and deprecated values are not generated for the properties that are defined using the setter/getter (those that have the @Input annotation before the setter).

Example: locale property in the Calendar component. It has the description and the deprecated annotation, but in the docs, it doesn't have any description and is not shown in strikethrough text as it should be as a deprecated property.

image

image

https://primeng.org/calendar

Environment

darwin arm64

Reproducer

No response

Angular version

17.0.5

PrimeNG version

17.6.0

Build / Runtime

Angular CLI App

Language

TypeScript

Node version (for AoT issues node --version)

20.11.0

Browser(s)

No response

Steps to reproduce the behavior

No response

Expected behavior

No response
@lukasmatta lukasmatta added the Status: Needs Triage Issue will be reviewed by Core Team and a relevant label will be added as soon as possible label Feb 8, 2024
@lukasmatta lukasmatta mentioned this issue Feb 8, 2024
Merged
@cetincakiroglu cetincakiroglu added this to the 17.13.0 milestone Mar 22, 2024
@cetincakiroglu cetincakiroglu added Type: Bug Issue contains a bug related to a specific component. Something about the component is not working Component: Documentation Issue or pull request is related to Documentation and removed Status: Needs Triage Issue will be reviewed by Core Team and a relevant label will be added as soon as possible labels Mar 22, 2024
cetincakiroglu added a commit that referenced this issue Mar 28, 2024
@cetincakiroglu
Merge pull request #14771 from lukasmatta/fix/14770-api-generator
3d7db6f 
Fixed #14770 - api-generator problem
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Component: Documentation Issue or pull request is related to Documentation Type: Bug Issue contains a bug related to a specific component. Something about the component is not working
Projects
None yet
Milestone
17.13.0
Development

Successfully merging a pull request may close this issue.

Fixed #14770 - api-generator problem lukasmatta/primeng
2 participants
@lukasmatta @cetincakiroglu