Return-Path: 
 <dev-return-7699-apmail-avro-dev-archive=avro.apache.org@avro.apache.org>
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 7B8977EE8
	for <apmail-avro-dev-archive@www.apache.org>;
 Fri, 16 Sep 2011 16:04:32 +0000 (UTC)
Received: (qmail 85093 invoked by uid 500); 16 Sep 2011 16:04:30 -0000
Delivered-To: apmail-avro-dev-archive@avro.apache.org
Received: (qmail 84917 invoked by uid 500); 16 Sep 2011 16:04:30 -0000
Mailing-List: contact dev-help@avro.apache.org; run by ezmlm
Precedence: bulk
List-Help: <mailto:dev-help@avro.apache.org>
List-Unsubscribe: <mailto:dev-unsubscribe@avro.apache.org>
List-Post: <mailto:dev@avro.apache.org>
List-Id: <dev.avro.apache.org>
Reply-To: dev@avro.apache.org
Delivered-To: mailing list dev@avro.apache.org
Received: (qmail 84902 invoked by uid 99); 16 Sep 2011 16:04:30 -0000
Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136)
    by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 16 Sep 2011 16:04:30 +0000
X-ASF-Spam-Status: No, hits=-2000.5 required=5.0
	tests=ALL_TRUSTED,RP_MATCHES_RCVD
X-Spam-Check-By: apache.org
Received: from [140.211.11.116] (HELO hel.zones.apache.org) (140.211.11.116)
    by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 16 Sep 2011 16:04:29 +0000
Received: from hel.zones.apache.org (hel.zones.apache.org [140.211.11.116])
	by hel.zones.apache.org (Postfix) with ESMTP id 462369D3DA
	for <dev@avro.apache.org>; Fri, 16 Sep 2011 16:04:09 +0000 (UTC)
Date: Fri, 16 Sep 2011 16:04:09 +0000 (UTC)
From: "George Fletcher (JIRA)" <jira@apache.org>
To: dev@avro.apache.org
Message-ID: 
 <1194496125.35151.1316189049284.JavaMail.tomcat@hel.zones.apache.org>
In-Reply-To: 
 <1096437130.3735.1315501688162.JavaMail.tomcat@hel.zones.apache.org>
Subject: [jira] [Commented] (AVRO-886) Support doc strings in IDL for
 protocols and message interfaces
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/AVRO-886?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13106554#comment-13106554 ] 

George Fletcher commented on AVRO-886:
--------------------------------------

Ok, new patch file (avro-doc-v3.patch) uploaded.

> Support doc strings in IDL for protocols and message interfaces
> ---------------------------------------------------------------
>
>                 Key: AVRO-886
>                 URL: https://issues.apache.org/jira/browse/AVRO-886
>             Project: Avro
>          Issue Type: Improvement
>    Affects Versions: 1.6.0
>            Reporter: George Fletcher
>             Fix For: 1.6.0
>
>         Attachments: avro-doc-v2.patch, avro-doc-v3.patch, avroTrace-bug.patch, idl-escapes.patch, newline-in-doc-test.patch
>
>
> I would like to be able to add documentation to the IDL that will get parsed with more types than Enum, Fixed and Record. Specifically, I'd like to support doc strings for protocols and message interfaces. One purpose is to be able to write the documentation into the generated code.
> The specific use case is to use information in the documentation strings to auto generate java annotations in the generated Java code. This is done with our own specifics compiler.
> Here is an example 'marked up' IDL file...
> /** class=@AccessControl(group="normal") */
> @namespace("com.aol.interfaces.echo")
> protocol EchoService {
>     import idl "Errors.avdl";
>     /** Message structure for the echo service */
>     record Message {
>         /** the string to be echo'd */
>         string echome;
>         map<string> echoes;
>     }
>     /** method=@AccessControl(source="MyService") */
>     string echoString(string msg) throws com.aol.interfaces.error.ServiceError;
>     Message echoMessage(Message msg) throws com.aol.interfaces.error.ServiceError;
>     void publishMessage(string msg) oneway;
> }

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira