search

flowable / flowable-engine

A compact and highly efficient workflow and Business Process Management (BPM) platform for developers, system admins and business users.
https://www.flowable.org
Apache License 2.0
7.95k stars 2.62k forks source link

Add all the things to javadocs #387

Open aaronkavlie-wf opened 7 years ago

aaronkavlie-wf commented 7 years ago

Some important packages are missing from the javadocs. For one example, there is no org.flowable.engine.impl. Everything under org.flowable.engine ought to be included.

dbmalkovsky commented 7 years ago

I believe that this because may not be exactly clear as to the intended audience for the JavaDocs. Is the JavaDoc for users of Flowable or for developers working on the Flowable code base?

Given statements such as the following in the User Doc it would reason that org.flowable.engine.impl would not be included and the audience is Flowable users.

1.7. Internal implementation classes

In the JAR files, all classes in packages that have .impl. (e.g. org.flowable.engine.impl.db) in their name are implementation classes and should be considered internal use only. No stability guarantees are given on classes or interfaces that are in implementation classes.

aaronkavlie-wf commented 7 years ago

A number of impl classes have made their way into our code (at least, our test code), such as org.flowable.engine.impl.cfg.StandaloneProcessEngineConfiguration. The docs encourage usage of other code in there too, such as org.flowable.engine.impl.bpmn.listener.ScriptTaskListener & org.flowable.engine.impl.history.HistoryLevel.

aaronkavlie-wf commented 7 years ago

There are other packages missing as well — org.flowable.idm and org.flowable.bpmn, for example. These packages include types returned by prominent public API methods.

namgang commented 6 years ago

Missing Javadocs is an impediment to getting up to speed with Flowable. For instance, the method TaskService.getIdentityLinksForTask() returns List which I believe is out of bounds as far as Javadocs go. There used to be an IdentityLinkType, but now it seems to be an arbitrary string. -- These are not questions to be answered here. It is an example of little things that one should be able to find out on one's own.

darkmastermindz commented 1 year ago

I agree that javadocs should be made up to date it makes it easier not only for users to understand the product but also for open source contributors.