#Scala documentation for fields of case classes - inline, or part of the top-level scaladoc?

I think I've been using both styles at random, but is there some "official" guidance as to which style is preferred?

Inline seems to be better when reading the source code, but top-level seems more consistent with documentation for normal classes & constructors.

@adamwarski@softwaremill.social I wasn't aware that the inline style was a thing... I think I'll start using that.

@JD557 @adamwarski Yikes, I wasn't aware either, since when?

@alexelcu @JD557 As it turns out, it's not, must have been my invention ;) Probably due to the parallel with method / value definitions (which can be "simply commented" using /** */). But it turns out my inline-style is not rendered in HTML, soI'll avoid using it from now.

@adamwarski inline looks way better, it removes the need for @param keyword + field name repetition, but does it produces the same scaladoc?

Also inline removes the need to ensure consistency between @param annotations and actual field declarations, even if this can be automated by tooling.

@mark Ah good point! :D I somehow assumed that both render the same.

But they do not: only the @param version shows the docs in the HTML version of the scaladoc. This settles this then. Thanks :)