Return-Path: X-Original-To: apmail-incubator-crunch-dev-archive@minotaur.apache.org Delivered-To: apmail-incubator-crunch-dev-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 993DA9E5F for ; Sun, 14 Oct 2012 20:03:03 +0000 (UTC) Received: (qmail 97274 invoked by uid 500); 14 Oct 2012 20:03:03 -0000 Delivered-To: apmail-incubator-crunch-dev-archive@incubator.apache.org Received: (qmail 97242 invoked by uid 500); 14 Oct 2012 20:03:03 -0000 Mailing-List: contact crunch-dev-help@incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: crunch-dev@incubator.apache.org Delivered-To: mailing list crunch-dev@incubator.apache.org Received: (qmail 97232 invoked by uid 99); 14 Oct 2012 20:03:03 -0000 Received: from arcas.apache.org (HELO arcas.apache.org) (140.211.11.28) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 14 Oct 2012 20:03:03 +0000 Date: Sun, 14 Oct 2012 20:03:03 +0000 (UTC) From: "Matthias Friedrich (JIRA)" To: crunch-dev@incubator.apache.org Message-ID: <139610146.43321.1350244983317.JavaMail.jiratomcat@arcas> In-Reply-To: <1260336067.42848.1350205505149.JavaMail.jiratomcat@arcas> Subject: [jira] [Resolved] (CRUNCH-95) Improve Javadoc MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 7bit X-JIRA-FingerPrint: 30527f35849b9dde25b450d4833f0394 [ https://issues.apache.org/jira/browse/CRUNCH-95?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Matthias Friedrich resolved CRUNCH-95. -------------------------------------- Resolution: Fixed Done. > Improve Javadoc > --------------- > > Key: CRUNCH-95 > URL: https://issues.apache.org/jira/browse/CRUNCH-95 > Project: Crunch > Issue Type: Improvement > Affects Versions: 0.3.0 > Reporter: Matthias Friedrich > Assignee: Matthias Friedrich > Fix For: 0.4.0 > > Attachments: 0001-CRUNCH-95-Improve-Javadocs.patch > > > As discussed on crunch-dev we should structure our API documentation better to help new users. This ticket is a first step towards that goal, consisting of two parts: > * Configure the javadoc plugin to include only client-facing packages > * Provide descriptions for these packages, improving the overview page > Moving code around is more controversial and will be done in a separate ticket. -- This message is automatically generated by JIRA. If you think it was sent incorrectly, please contact your JIRA administrators For more information on JIRA, see: http://www.atlassian.com/software/jira