[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[ecf-dev] JavaDoc (or lack thereof)
- From: Alex Blewitt <alex.blewitt@xxxxxxxxx>
- Date: Fri, 27 May 2011 14:50:28 +0100
- Delivered-to: email@example.com
- Dkim-signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=gamma; h=domainkey-signature:from:content-type:content-transfer-encoding :subject:date:message-id:to:mime-version:x-mailer; bh=ZPz6krOcNpVABv/eNfZq8Ud+hvVpOrA1eS6O7LnvFAI=; b=HwOyDAeS3UDof6T56eBms1GrSRraEp2p6t6gHTGNwJ1gNsGJfsef+xRv3kcDh2tGr7 23ZMAR9SOb1bbEcoQKUwjFWEF/Kyb49pR8xkheduhK7v2ndc0kuymHSv0PBRaLM1cFWM 1zZHOdNUx0SxkQrRQUzIUB27SAxztPM5zOs+4=
- Domainkey-signature: a=rsa-sha1; c=nofws; d=gmail.com; s=gamma; h=from:content-type:content-transfer-encoding:subject:date:message-id :to:mime-version:x-mailer; b=gU89IVra3kwvcLiqpFTdAFL90oTW6dLhNsWqNwVsgAj6TjtNgeZi1/UoVMtPgEYtlM QzPJJ/zkcgXNnFsh1Zv574BqcYNB/RjrJJAkj0pVRYkI7S4dwp7NcLWjTOt6wxrAzZzR XJ6utfTVlmAGsaQ9PFpQPsH3DyD+DQiDdobU8=
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 :)