Skip to content

Dottydoc doesn't support multiple @usecase sections #4752

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.

Sign up for GitHub

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

Jump to bottom
Closed
Duhemm opened this issue Jul 2, 2018 · 0 comments
Closed

Dottydoc doesn't support multiple @usecase sections #4752

Duhemm opened this issue Jul 2, 2018 · 0 comments
Labels
area:doctool itype:bug

Comments

@Duhemm
Copy link
Contributor

Duhemm commented Jul 2, 2018 •
edited
Loading

scaladoc allows several @usecase sections to exist in a doc comment:

  /**
   * @usecase def foo: String
   * @usecase def foo: Int
   */
  def foo(x: Int): Unit

It renders them as several different definitions in the docsite:

screen shot 2018-07-02 at 11 25 48

Currently, dottydoc will only show the first @usecase.

Dottydoc should do the same thing.
Duhemm added a commit to dotty-staging/dotty that referenced this issue Jul 2, 2018
@Duhemm
Fix scala#4752: Support multiple @usecase sections
4a52fcf 
In the documentation, it is possible to have several `@usecase`
sections, which means that each of these section should be displayed as
a separate member in the documentation. So far, Dottydoc was only
considering the first `@usecase` section and was disregarding the
others.

This commit fixes that, and generates a new member for each of the
usecases.

Fixes scala#4752
Duhemm added a commit to dotty-staging/dotty that referenced this issue Jul 12, 2018
@Duhemm
Fix scala#4752: Support multiple @usecase sections
5da30fe 
In the documentation, it is possible to have several `@usecase`
sections, which means that each of these section should be displayed as
a separate member in the documentation. So far, Dottydoc was only
considering the first `@usecase` section and was disregarding the
others.

This commit fixes that, and generates a new member for each of the
usecases.

Fixes scala#4752
Duhemm added a commit to dotty-staging/dotty that referenced this issue Jul 13, 2018
@Duhemm
Fix scala#4752: Support multiple @usecase sections
e2c4368 
In the documentation, it is possible to have several `@usecase`
sections, which means that each of these section should be displayed as
a separate member in the documentation. So far, Dottydoc was only
considering the first `@usecase` section and was disregarding the
others.

This commit fixes that, and generates a new member for each of the
usecases.

Fixes scala#4752
Duhemm added a commit to dotty-staging/dotty that referenced this issue Jul 13, 2018
@Duhemm
Fix scala#4752: Support multiple @usecase sections
f1da1e1 
In the documentation, it is possible to have several `@usecase`
sections, which means that each of these section should be displayed as
a separate member in the documentation. So far, Dottydoc was only
considering the first `@usecase` section and was disregarding the
others.

This commit fixes that, and generates a new member for each of the
usecases.

Fixes scala#4752
Duhemm added a commit to dotty-staging/dotty that referenced this issue Aug 2, 2018
@Duhemm
Fix scala#4752: Support multiple @usecase sections
ea9d9ad 
In the documentation, it is possible to have several `@usecase`
sections, which means that each of these section should be displayed as
a separate member in the documentation. So far, Dottydoc was only
considering the first `@usecase` section and was disregarding the
others.

This commit fixes that, and generates a new member for each of the
usecases.

Fixes scala#4752
@Duhemm Duhemm closed this as completed in 10de931 Sep 4, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area:doctool itype:bug
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Duhemm