genjavadoc icon indicating copy to clipboard operation
genjavadoc copied to clipboard

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

Open kpritam opened this issue 7 years ago • 3 comments

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.

kpritam avatar Mar 15 '18 06:03 kpritam

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?

2m avatar Mar 15 '18 12:03 2m

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

Dollyg avatar Jan 16 '19 09:01 Dollyg

No plans. A pull request would be welcome.

SethTisue avatar Jan 16 '19 15:01 SethTisue