ignite-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Pavel Tupitsyn (JIRA)" <j...@apache.org>
Subject [jira] [Created] (IGNITE-6253) .NET: Replace Doxygen with DocFX for API documentation generation
Date Mon, 04 Sep 2017 09:45:01 GMT
Pavel Tupitsyn created IGNITE-6253:

             Summary: .NET: Replace Doxygen with DocFX for API documentation generation
                 Key: IGNITE-6253
                 URL: https://issues.apache.org/jira/browse/IGNITE-6253
             Project: Ignite
          Issue Type: Improvement
          Components: documentation, platforms
            Reporter: Pavel Tupitsyn
            Assignee: Pavel Tupitsyn
             Fix For: 2.3

Doxygen has recently became very slow on our code base (can take up to 30 minutes), and there
seems to be no solution to this problem. There are other issues: documentation is a bit ugly,
customization possibilities are limited, C# is not a first-class citizen there.

[DocFX|https://dotnet.github.io/docfx/] looks like an obvious replacement:
* It is a go-to documentation generator for .NET (included in .NET Foundation)
* Documentation looks nice (MSDN-like) out of the box
* Migration seems to be easy enough

This message was sent by Atlassian JIRA

View raw message