#Re-exported declarations doc comments issue

1 messages · Page 1 of 1 (latest)

tiny cedar
#

At least on VS Code, the following happens (attached image).
The style namespace has doc comments, and I'm also adding on top of it its doc comment (just for testing its behavior).
But looking at the generated documentation, the one added on the re-exported declaration isn't rendered.

So, I'm wondering whether or not this behavior is documented, as an issue or somewhere.

Well, it ended up being a bit stranger XD
See 2 attached images.

#

For some reason the normal doc comment is being attached to the container doc comment

#

And ZLS is attaching the doc comment differently than the doc generator

#

issues on both sides

#

Re-exported declarations doc comments issue

tight raft
#

May i ask how do we generate documentation ?

tiny cedar
#

For a library you usually just define the module, make it into a library and get the docs out of it

tiny cedar
#

Mostly via the guide

#

I'll share it in a bit

tiny cedar
#

And then check on my github action how it's deployed to the pages, but yeah, just check from the docs step and below