You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@avro.apache.org by "Lars Francke (Created) (JIRA)" <ji...@apache.org> on 2012/01/25 14:08:40 UTC
[jira] [Created] (AVRO-1010) Improve Javadoc for CodecFactory,
AvroJob and AvroOutputFormat mostly concerning compression
Improve Javadoc for CodecFactory, AvroJob and AvroOutputFormat mostly concerning compression
--------------------------------------------------------------------------------------------
Key: AVRO-1010
URL: https://issues.apache.org/jira/browse/AVRO-1010
Project: Avro
Issue Type: Improvement
Components: doc
Affects Versions: 1.6.1
Reporter: Lars Francke
Assignee: Lars Francke
Priority: Minor
CodecFactory doesn't mention which codecs are registered and some comments make it seem as it this takes a full class name. The registered codecs should be documented. Similarly AvroOutputFormat doesn't document how it can be configured to use compression.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Updated] (AVRO-1010) Improve Javadoc for CodecFactory,
AvroJob and AvroOutputFormat mostly concerning compression
Posted by "Lars Francke (Updated) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/AVRO-1010?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Lars Francke updated AVRO-1010:
-------------------------------
Attachment: AVRO-1010.1.patch
Added Javadoc to document a few things.
Only code change is removing superflous semicolons after methods... I don't know why they were there but I was working on the class anyway so I hope it's okay otherwise I'll provide a patch without that change.
Can't put it on Review Board because there's no "avro-git" repository.
> Improve Javadoc for CodecFactory, AvroJob and AvroOutputFormat mostly concerning compression
> --------------------------------------------------------------------------------------------
>
> Key: AVRO-1010
> URL: https://issues.apache.org/jira/browse/AVRO-1010
> Project: Avro
> Issue Type: Improvement
> Components: doc
> Affects Versions: 1.6.1
> Reporter: Lars Francke
> Assignee: Lars Francke
> Priority: Minor
> Attachments: AVRO-1010.1.patch
>
>
> CodecFactory doesn't mention which codecs are registered and some comments make it seem as it this takes a full class name. The registered codecs should be documented. Similarly AvroOutputFormat doesn't document how it can be configured to use compression.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Updated] (AVRO-1010) Improve Javadoc for CodecFactory,
AvroJob and AvroOutputFormat mostly concerning compression
Posted by "Lars Francke (Updated) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/AVRO-1010?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Lars Francke updated AVRO-1010:
-------------------------------
Status: Patch Available (was: Open)
> Improve Javadoc for CodecFactory, AvroJob and AvroOutputFormat mostly concerning compression
> --------------------------------------------------------------------------------------------
>
> Key: AVRO-1010
> URL: https://issues.apache.org/jira/browse/AVRO-1010
> Project: Avro
> Issue Type: Improvement
> Components: doc
> Affects Versions: 1.6.1
> Reporter: Lars Francke
> Assignee: Lars Francke
> Priority: Minor
> Attachments: AVRO-1010.1.patch
>
>
> CodecFactory doesn't mention which codecs are registered and some comments make it seem as it this takes a full class name. The registered codecs should be documented. Similarly AvroOutputFormat doesn't document how it can be configured to use compression.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Updated] (AVRO-1010) Improve Javadoc for CodecFactory,
AvroJob and AvroOutputFormat mostly concerning compression
Posted by "Doug Cutting (Updated) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/AVRO-1010?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Doug Cutting updated AVRO-1010:
-------------------------------
Resolution: Fixed
Fix Version/s: 1.6.2
Status: Resolved (was: Patch Available)
I removed references to non-public classes from the added javadoc & committed this.
Thanks, Lars!
> Improve Javadoc for CodecFactory, AvroJob and AvroOutputFormat mostly concerning compression
> --------------------------------------------------------------------------------------------
>
> Key: AVRO-1010
> URL: https://issues.apache.org/jira/browse/AVRO-1010
> Project: Avro
> Issue Type: Improvement
> Components: doc
> Affects Versions: 1.6.1
> Reporter: Lars Francke
> Assignee: Lars Francke
> Priority: Minor
> Fix For: 1.6.2
>
> Attachments: AVRO-1010.1.patch
>
>
> CodecFactory doesn't mention which codecs are registered and some comments make it seem as it this takes a full class name. The registered codecs should be documented. Similarly AvroOutputFormat doesn't document how it can be configured to use compression.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Commented] (AVRO-1010) Improve Javadoc for CodecFactory,
AvroJob and AvroOutputFormat mostly concerning compression
Posted by "Scott Carey (Commented) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/AVRO-1010?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13202045#comment-13202045 ]
Scott Carey commented on AVRO-1010:
-----------------------------------
+1, looks good.
> Improve Javadoc for CodecFactory, AvroJob and AvroOutputFormat mostly concerning compression
> --------------------------------------------------------------------------------------------
>
> Key: AVRO-1010
> URL: https://issues.apache.org/jira/browse/AVRO-1010
> Project: Avro
> Issue Type: Improvement
> Components: doc
> Affects Versions: 1.6.1
> Reporter: Lars Francke
> Assignee: Lars Francke
> Priority: Minor
> Attachments: AVRO-1010.1.patch
>
>
> CodecFactory doesn't mention which codecs are registered and some comments make it seem as it this takes a full class name. The registered codecs should be documented. Similarly AvroOutputFormat doesn't document how it can be configured to use compression.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira