[
https://issues.apache.org/jira/browse/AVRO-2155?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16394288#comment-16394288
]
ASF GitHub Bot commented on AVRO-2155:
--------------------------------------
blachniet opened a new pull request #296: AVRO-2155: Include documentation for
named schemas in generated code
URL: https://github.com/apache/avro/pull/296
[AVRO-2155](https://issues.apache.org/jira/browse/AVRO-2155)
1. Added `Documentation` property to `NamedSchema`, as well as an argument
in the constructor to accept the value for the property
2. Added unit tests for the `Documentation`: `TestEumDoc`, `TestFixedDoc`
and `TestRecordDoc`
3. In `CodeGen.cs`, added comments to the generated fixed, enum and record
code declarations.
4. Unrelated change: Added missing parameter documentation on `EnumSchema`,
`FixedSchema`, `NamedSchema` and `RecordSchema` documentation
I didn't see a good way to unit test the documentation in the generated
code. As an alternative, I've added
[sample.zip](https://github.com/apache/avro/files/1799659/sample.zip)
containing a sample protocol and before/after generated code for comparison.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
> Generate documentation for C# classes and enums
> -----------------------------------------------
>
> Key: AVRO-2155
> URL: https://issues.apache.org/jira/browse/AVRO-2155
> Project: Avro
> Issue Type: New Feature
> Components: csharp
> Affects Versions: 1.8.2
> Reporter: Brian Lachniet
> Priority: Minor
>
> Update the C# "avrogen" code generation to populate documentation for code
> entities (classes and enums) that are generated from named schemas (record,
> enum and fixed). At this time, it only generates documentation for Avro
> fields (C# fields and properties).
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
