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

JSDocs are missing for overloaded functions #10012

Closed
alansemenov opened this issue Jan 31, 2023 · 1 comment
Closed

JSDocs are missing for overloaded functions #10012

alansemenov opened this issue Jan 31, 2023 · 1 comment
Assignees
@edloidas
Labels
Bug
Milestone
7.12.0

Comments

@alansemenov
Copy link
Member

alansemenov commented Jan 31, 2023 •
edited
Loading

https://developer.enonic.com/docs/xp/stable/api/lib-node#get

Declared here but is missing here.
@alansemenov alansemenov changed the title JSDocs are missing examples for nested API methods JSDocs are missing description and examples for get in Node API Jan 31, 2023
@alansemenov alansemenov assigned edloidas and unassigned rymsha Jan 31, 2023
@edloidas edloidas changed the title JSDocs are missing description and examples for get in Node API JSDocs are missing for overloaded functions Feb 1, 2023
@edloidas
Copy link
Member

edloidas commented Feb 1, 2023 •
edited
Loading

Lib Auth also misses several such functions. This happens, because the first function definitions before the actual implantation get removed and an empty line appears between the actual function and the doc in resulted JS, so it's getting removed, as not connected to anything.

edloidas added a commit that referenced this issue Feb 1, 2023
@edloidas
JSDocs are missing for overloaded functions #10012
098ecee
rymsha pushed a commit that referenced this issue Feb 3, 2023
@edloidas
JSDocs are missing for overloaded functions #10012 (#10013)
97dd95a
@rymsha rymsha added this to the 7.12.0 milestone Feb 3, 2023
rymsha pushed a commit that referenced this issue Feb 3, 2023
@edloidas @rymsha
JSDocs are missing for overloaded functions #10012 (#10013)
dbe1da6 
(cherry picked from commit 97dd95a)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@edloidas edloidas

Labels
Bug
Projects
None yet
Milestone
7.12.0
Development

No branches or pull requests
3 participants
@edloidas @rymsha @alansemenov