Re: [jts-dev] JTS Javadoc in a different layout and with more features

[Sebastian Kürten <sebastian.kuerten@xxxxxxxxxxxx>]

Thanks Jody, I just implemented that, so Geometry is now showing the
direct known subclasses. I guess an extension would be to also show
_all_ known subclasses, such that for example LinearRing would also
appear, same as MultiPoint, MultiLineString and MultiPolygon. That
section could be named 'indirect' or 'transitive known subclasses'. Do
you think that would make sense?

Also, I added similar behavior for interfaces, for example Polygonal
now has the section 'all known implementing classes' showing
MultiPolyon and Polygon.

Concerning the non-repeated javadoc for overridden methods, at the
moment they are not appearing at all yet, but I like the idea of making
it somehow visible that the comment is just copied. I could also think
of moving them to the bottom of the page. By the way the order of
methods is different from classical javadoc at the moment, anyways.
Classical javadoc orders methods by name, our tool currently keeps the
order they are defined in. Eclipse allows me to choose between
alphabetic order and declared order and I like the idea of giving the
user a choice here, so I would like to include that feature eventually.

On Mon, 21 Sep 2020 16:17:27 -0700
Jody Garnett <jody.garnett@xxxxxxxxx> wrote:

> Glad you are having fun.
> 
>    - One of the first things I did was go to Geometry, and missed the
>    opportunity to view the sub classes (or perhaps I did not find it?)
>    - Looking at a specific subclass like LineString is really shows
> how JTS does not repeat javadoc descriptions for methods that are an
> @Override.
>    - A useful idea would be to pull the javadoc description unchanged
> and present it in a faded out presentation if it is just a override
> (I think the default treats that as "Description copied from class:
> Geometry").
> 
> --
> Jody Garnett
> 
> 
> On Mon, 21 Sep 2020 at 08:11, Sebastian Kürten <
> sebastian.kuerten@xxxxxxxxxxxx> wrote:
> 
> > Hi,
> >
> > we're working on a new toolchain for generating Javadocs. Since I
> > am a frequent user of JTS, I'm using it as a showcase and I thought
> > I might as well share it with the community. It's located here:
> >
> > https://javadocng.mobanisto.com/jts-1.17.1/
> >
> > I tried to adapt the color scheme for the header from the main
> > website (https://locationtech.github.io/jts/). Also I'm using the
> > package grouping used on the normal javadocs, derived it from the
> > pom.xml.
> >
> > I'd be delighted if you try it and see if you find it useful and
> > share any feedback you might have. We have already added quite a few
> > features we think improve the classic javadocs, however it would be
> > very interesting to know if you are annoyed by anything on the
> > classical javadocs that could be changed in an improved version.
> > Also it is a work in progress, so some things are not working quite
> > yet.
> >
> > If you like to know more about it, there's also some more
> > information available about the new toolchain on the Github project
> > (https://github.com/sebkur/javadoc-ng)
> >
> > Thank you,
> > Sebastian
> > _______________________________________________
> > jts-dev mailing list
> > jts-dev@xxxxxxxxxxx
> > To unsubscribe from this list, visit
> > https://dev.eclipse.org/mailman/listinfo/jts-dev
> >