Skip to content

Doctool doesn't group items as specified by the documentation #14515

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

Closed
anatoliykmetyuk opened this issue Feb 18, 2022 · 0 comments · Fixed by #14577
Closed

Doctool doesn't group items as specified by the documentation #14515

anatoliykmetyuk opened this issue Feb 18, 2022 · 0 comments · Fixed by #14577
Assignees
Milestone

Comments

@anatoliykmetyuk
Copy link
Contributor

Compiler version

3.1.1

Minimized code

object stuff:
  /** @group foo */ def foo = 10
  /** @group bar */ def bar = 20

In build.sbt:

Compile / doc / scalacOptions ++= List("-groups")

As specified at https://dotty.epfl.ch/docs/usage/scaladoc/docstrings.html#member-grouping-tags

Output

cleanshot_2022-02-18_at_16 31 12_2x

Expectation

I expect the elements to be grouped to foo and bar categories.

Workaround

Put the following in build.sbt:

Compile / doc / scalacOptions ++= List("-groups", "-comment-syntax", "wiki")
@anatoliykmetyuk anatoliykmetyuk added itype:bug stat:needs triage Every issue needs to have an "area" and "itype" label area:doctool and removed stat:needs triage Every issue needs to have an "area" and "itype" label labels Feb 18, 2022
@Kordyjan Kordyjan added this to the 3.1.3 milestone Aug 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants