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

feat: multiline ---@param description #22

Merged
merged 2 commits into from
Jul 5, 2022
Merged

feat: multiline ---@param description #22

merged 2 commits into from
Jul 5, 2022

Conversation

numToStr
Copy link
Owner

@numToStr numToStr commented Jul 1, 2022

Resolves #20

@numToStr
Copy link
Owner Author

numToStr commented Jul 1, 2022

@mfussenegger I hope this will work for you :)

@numToStr numToStr merged commit 2ad346a into master Jul 5, 2022
@numToStr numToStr deleted the param/multi-line branch July 5, 2022 13:13
@mfussenegger
Copy link

I had in mind that the annotations in the code keep using @class and so on, but that the generated documentation would look as if it it were inlined (maybe via an option).

But this should be fine as well.

@numToStr
Copy link
Owner Author

numToStr commented Jul 6, 2022

but that the generated documentation would look as if it it were inlined (maybe via an option).

Yeah, that's the downside (loosing LLS support) of the current approach. But inlining class is also that'll be useful but is bigger to implement, I'll surely look into.

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.

Ability to inline class definition in generated docs
2 participants