Restructuring Javadoc and Scaladoc for libraries

[Chiwan Park-2]

Hi all,

I just noticed some scaladocs (Gelly Scala API, Streaming Scala API, and FlinkML) are missing in scaladoc page but found in javadoc page, even though the APIs are for Scala. Is this intentional?

I think we have to move some documentation to scaladoc.

Regards,
Chiwan Park

[Robert Metzger]

Hi Chiwan,

I think that's something we need to address. Probably the scaladoc plugin
is not configured correctly everywhere.

On Thu, Jul 14, 2016 at 3:59 AM, Chiwan Park <[hidden email]> wrote:

> Hi all,
>
> I just noticed some scaladocs (Gelly Scala API, Streaming Scala API, and
> FlinkML) are missing in scaladoc page but found in javadoc page, even
> though the APIs are for Scala. Is this intentional?
>
> I think we have to move some documentation to scaladoc.
>
> Regards,
> Chiwan Park
>
>

[Chiwan Park-2]

Hi Robert,

Thanks for clarifying! I’ve filed this [1].

Regards,
Chiwan Park

[1]: https://issues.apache.org/jira/browse/FLINK-4223

> On Jul 14, 2016, at 9:56 PM, Robert Metzger <[hidden email]> wrote:
>
> Hi Chiwan,
>
> I think that's something we need to address. Probably the scaladoc plugin
> is not configured correctly everywhere.
>
> On Thu, Jul 14, 2016 at 3:59 AM, Chiwan Park <[hidden email]> wrote:
>
>> Hi all,
>>
>> I just noticed some scaladocs (Gelly Scala API, Streaming Scala API, and
>> FlinkML) are missing in scaladoc page but found in javadoc page, even
>> though the APIs are for Scala. Is this intentional?
>>
>> I think we have to move some documentation to scaladoc.
>>
>> Regards,
>> Chiwan Park
>>
>>

[Aljoscha Krettek-2]

Hi,
it's somewhat tricky to do Doc aggregation with ScalaDoc. At least it used
to be back when I initially set it up just for the Scala Batch API. Maybe
it's a bit easier now.

Cheers,
Aljoscha

On Sat, 16 Jul 2016 at 05:21 Chiwan Park <[hidden email]> wrote:

> Hi Robert,
>
> Thanks for clarifying! I’ve filed this [1].
>
> Regards,
> Chiwan Park
>
> [1]: https://issues.apache.org/jira/browse/FLINK-4223
>
> > On Jul 14, 2016, at 9:56 PM, Robert Metzger <[hidden email]> wrote:
> >
> > Hi Chiwan,
> >
> > I think that's something we need to address. Probably the scaladoc plugin
> > is not configured correctly everywhere.
> >
> > On Thu, Jul 14, 2016 at 3:59 AM, Chiwan Park <[hidden email]>
> wrote:
> >
> >> Hi all,
> >>
> >> I just noticed some scaladocs (Gelly Scala API, Streaming Scala API, and
> >> FlinkML) are missing in scaladoc page but found in javadoc page, even
> >> though the APIs are for Scala. Is this intentional?
> >>
> >> I think we have to move some documentation to scaladoc.
> >>
> >> Regards,
> >> Chiwan Park
> >>
> >>
>
>