Broadleaf Commerce Discussion Forums

Hi,

Broadleaf commerce is great, but I think the documentation could be better.

Because an online documentation is very difficult to maintain I think there are things to do to improve the Javadoc first (this improvement task could be performed progressively...) .

I'm currently working with broadleaf but I lost a lot of time because many functions have not been documentation (so I have to look at the source code each time to know what each function really do).
Each function defined on interfaces should be documented.

Using checkstyle to check missing Javadoc can be a beginning to check classes and functions which do no have been documented.

Is the configuration of checkstyle in Eclipse / Maven broadleaf projects planned in the road map ? Do you think it's a good idea ?

Thanks,

Baptiste

Yes - we know that documentation (javadocs and online docs) is an area where we need some improvement. We're currently working to get code complete for 1.5 and then we will circle back around and fill in the gaps for the docs. Going forward, we plan to attack javadocs especially as part of the development process (up till now, we've been pretty slammed trying to reach client deadlines).