Return-Path: X-Original-To: apmail-avro-dev-archive@www.apache.org Delivered-To: apmail-avro-dev-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 134A818779 for ; Thu, 25 Jun 2015 20:14:05 +0000 (UTC) Received: (qmail 81470 invoked by uid 500); 25 Jun 2015 20:14:04 -0000 Delivered-To: apmail-avro-dev-archive@avro.apache.org Received: (qmail 81405 invoked by uid 500); 25 Jun 2015 20:14:04 -0000 Mailing-List: contact dev-help@avro.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@avro.apache.org Delivered-To: mailing list dev@avro.apache.org Received: (qmail 81394 invoked by uid 99); 25 Jun 2015 20:14:04 -0000 Received: from arcas.apache.org (HELO arcas.apache.org) (140.211.11.28) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 25 Jun 2015 20:14:04 +0000 Date: Thu, 25 Jun 2015 20:14:04 +0000 (UTC) From: =?utf-8?Q?Charles_Gari=C3=A9py-Ikeson_=28JIRA=29?= To: dev@avro.apache.org Message-ID: In-Reply-To: References: Subject: [jira] [Updated] (AVRO-1681) Improve generated JavaDocs MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-JIRA-FingerPrint: 30527f35849b9dde25b450d4833f0394 [ https://issues.apache.org/jira/browse/AVRO-1681?page=3Dcom.atlassian= .jira.plugin.system.issuetabpanels:all-tabpanel ] Charles Gari=C3=A9py-Ikeson updated AVRO-1681: ----------------------------------------- Attachment: AVRO-1681-TRUNK.patch Patch for AVRO-1681 on TRUNK. > Improve generated JavaDocs > -------------------------- > > Key: AVRO-1681 > URL: https://issues.apache.org/jira/browse/AVRO-1681 > Project: Avro > Issue Type: Improvement > Components: java > Affects Versions: 1.7.7 > Reporter: Charles Gari=C3=A9py-Ikeson > Priority: Minor > Fix For: 1.7.8 > > Attachments: AVRO-1681-TRUNK.patch, AVRO-1681.patch > > > Hi everyone! > I've noticed that the JavaDocs generated by the SpecificCompiler could us= e a little TLC. Our usage of Avro includes the IPC component, and it would = be nice if the JavaDocs that were generated from our avpr files were a litt= le more verbose, especially when working with IDEs that integrate JavaDocs = from the classes we are using. It would help usage of the interfaces and cl= asses generated from the protocol file, without having to dive deeper into = the class or protocol file from which it was generated. > I've made a first attempt at accomplishing this. This is my first patch, = so don't hesitate to point out something I've missed or needs improving. -- This message was sent by Atlassian JIRA (v6.3.4#6332)