Skip to content
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

Package object scala docs does not get converted to java package docs. #131

Open
kpritam opened this issue Mar 15, 2018 · 3 comments
Open

Comments

@kpritam
Copy link

kpritam commented Mar 15, 2018

I have a package structure which has scala files but provides Java API as well.
But everything is written in scala. I am using genJavaDoc to generate java documentation. It does get generated for scala classes but package documentation does not get generated for javadoc.

I jave followinf package structure:
com.example.javadsl

  • javadsl.scala
  • ILocationService.scala

javadsl.scala looks like this:

package com.example

/**
 * Location service API exposed to external world.
 */
package object javadsl {}

When I generate java doc using javaunidoc:doc, it does not generate package documentation.

@2m
Copy link
Contributor

2m commented Mar 15, 2018

Ahh, that would be nice indeed. The plugin would need to place these pacakge comments to a separate package-info.java file which is used to generate the package documentation by the javadoc.

Would you be up for implementing this?

@Dollyg
Copy link

Dollyg commented Jan 16, 2019

Yes, its indeed a good feature. are there any plans to implement this in near future?

@SethTisue
Copy link
Member

No plans. A pull request would be welcome.

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

No branches or pull requests

4 participants