avro-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Doug Cutting (JIRA)" <j...@apache.org>
Subject [jira] [Updated] (AVRO-886) Support doc strings in IDL for protocols and message interfaces
Date Wed, 14 Sep 2011 21:18:11 GMT

     [ https://issues.apache.org/jira/browse/AVRO-886?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]

Doug Cutting updated AVRO-886:
------------------------------

    Attachment: newline-in-doc-test.patch

> JSON doc strings need newlines to be escaped.

Jackson does not usually emit JSON it cannot parse.  Here's a patch that adds a test of parsing
newlines in a doc string.  The modified test passes for me.  Where are you seeing failures?


> 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.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

        

Mime
View raw message