Host API docs (Javadoc) of platform online

Ideas
#1

Hi,

i oftentimes find it very convenient to have a API documentation online next to the developers manual (like Spring does e.g.: Overview (Spring Framework 6.0.5 API)) . Of course one could go to github and use the search option of the repository, but often it is not necessary to see the implementation as well (although it is oftentimes interesting to see :))

Additionally, Google could (and will) do us a favor, and makes the APIs much more easily accessible…

What do you think, could you host a Javadoc version of the platform API’s?

Bye,
Mario

#2

Hi Mario,
You are right, published JavaDocs can be useful. We’ll certainly do it in the next couple of months, but first we should add more content in the JavaDocs and clean them up.

2 Likes
#3

Hi Konstantin,

sounds reasonable, although i think (at least the classes i came across) that the existing Javadoc comments aren’t that bad. But you will probably know better about that one.

Looking forward to it.
Bye
Mario

#4

I am also looking forward for the Javadoc.

Kind regards
George

#5

Browsing the API with bad or no comments is better than viewing the source on Github to figure it out. I look forward to published Javadocs.

#6

Any progress on the API docs?
It will be a very helpful addition.

1 Like
#7

Thanks for reminding. It’s still on the backlog, but we are certainly approaching the point when we start working on it.

1 Like
#8

Hi. I am also waiting for the Javadocs. Now I am specifically interested in looking into charts (maps) package methods. So meanwhile, is charts package available as source code somewhere. I didn’t find it on GitHub. I was planning to create Javadoc myself while its not available online, but cannot find the source code, for instance com.haulmont.charts.gui.map.model.*

Thanks,
Hannu

#9

Hi Hannu,

is charts package available as source code somewhere

The full source code is available in your IDE if you include the charts application component into your project.

#11

Hi, community!

Javadocs have been published, API Reference tab.

Welcome to PR on GitHub :slight_smile:

2 Likes