search

Beh01der / EasyFlow

EasyFlow - Simple and lightweight Finite State Machine for Java
http://datasymphony.com.au/open-source/easyflow
Apache License 2.0
444 stars 86 forks source link

JavaDoc #13

Open gaffney opened 10 years ago

gaffney commented 10 years ago

Hello.

I realize this library is relatively easy to use and the error messages are telling (thanks) but it would still be nice if every exposed object/method had JavaDoc so users don't have to do trial-and-error when learning it.

One concrete example I had that was slightly frustrating is when I was encountering a race condition error when I didn't have an executor (it said I was in state "null" when I called 'trigger'; yet when I debugged it showed it in state "INITIAL_STATE" and it passed the trigger fine.) If I knew how this executor was used, I might have known to use it and thus avoided that race condition issue.

P.S. Not sure if the above is expected behavior.

lkwg82 commented 10 years ago

Hi Gaffney,

what about a pull request to suggest some enhancements?

Cheers Lars