[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [ecf-dev] JavaDoc (or lack thereof)

Hi Alex,

First, thanks for the offer of contribution/help with the documentation. It's an ongoing problem that we are trying to address (with the help of the community).

Have you consulted the generated javadocs? http://www.eclipse.org/ecf/org.eclipse.ecf.docs/api/

Although we are aware that there are plenty of missing pieces to this and other ECF documentation. ECF now has a 'documentation project' where we've been trying to coordinate community contributions to address the lack of ECF documentation problem...and I think that would probably be the best way for you to coodinate your contributions as well.

Here [1] is a link to ECF documentation project links on the wiki. There's a bug listed there [2] that hopefully you can join and we can continue to use that to coordinate the mechanisms for various kinds of documentation contributions. If you are interested, we can examine making you an ECF committer.

WRT patches via git...this is still a problem. Anyone have ideas on how to manage patches/contributions with git?



[1] http://wiki.eclipse.org/ECF#ECF_Documentation_Project
[2] https://bugs.eclipse.org/bugs/show_bug.cgi?id=329124

On 5/27/2011 6:50 AM, Alex Blewitt wrote:
In working through setting up an ECF container, I noticed a serious lack of JavaDoc documentation, which hindered by ability to figure out what was going on. This, and finding out who the key actors are and how they're invoked made it more difficult than it needs to be in order to find out what's going on.

I'd like to help improve that situation by starting to create documentation for the framework and the like. I have a fork of the GitHub instance where I'm planning to do my work there - does that make the best place? We can then review any changes necessary prior to committing in as a bugzilla instance.

I'm also an Eclipse committer as well (though haven't actually committed anything directly) so don't know if that makes it easier to hook up. But hopefully it means my committer ID will allow me to have the changes absorbed as is. The whole Git attached as patches is somewhat new to me :)

ecf-dev mailing list