Skip to content

feat: multiline ---@param description - #22

Merged
numToStr merged 2 commits into
masterfrom
param/multi-line
Jul 5, 2022
Merged

numToStr merged 2 commits into
masterfrom
param/multi-line

Conversation

@numToStr

@numToStr numToStr commented Jul 1, 2022

Copy link
Copy Markdown
Owner

Resolves #20

@numToStr

numToStr commented Jul 1, 2022

Copy link
Copy Markdown
Owner Author

@mfussenegger I hope this will work for you :)

@numToStr
numToStr force-pushed the param/multi-line branch from f460468 to b2ca9c8 Compare July 5, 2022 09:41
@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
Copy Markdown

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

numToStr commented Jul 6, 2022

Copy link
Copy Markdown
Owner Author

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