Brian Lachniet created AVRO-2158:
------------------------------------
Summary: Modernize C# Documentation
Key: AVRO-2158
URL: https://issues.apache.org/jira/browse/AVRO-2158
Project: Avro
Issue Type: New Feature
Components: csharp, doc
Reporter: Brian Lachniet
I'd like to propose that we "modernize" the Avro C# documentation using
[DocFX|https://dotnet.github.io/docfx/]. This is the closest thing that C# has
to Javadoc. I threw together a quick example of what this would look like here:
[https://blachniet.github.io/avro-csharp-docs/api/Avro.html]
* [GitHub Repo Containing Site
Source|https://github.com/blachniet/avro-csharp-docs]
* [Branch from which site was generated - see the /lang/csharp/docs
folder|https://github.com/blachniet/avro/tree/docs/lang/csharp]
DocFX uses the triple-slash documentation in the C# code to generate API
documentation. It also allows for conceptual documentation (getting started
guides, tutorials, articles, etc.).
If there is no opposition, I will pull together a legitimate solution (what
I've got right now was thrown together in a few minutes).
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
