You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@ignite.apache.org by "Pavel Tupitsyn (JIRA)" <ji...@apache.org> on 2017/09/04 11:31:02 UTC
[jira] [Updated] (IGNITE-6253) .NET: Replace Doxygen with DocFX for
API documentation generation
[ https://issues.apache.org/jira/browse/IGNITE-6253?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Pavel Tupitsyn updated IGNITE-6253:
-----------------------------------
Description:
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
To do:
* Remove {{Package-Info.cs}} files, they don't make sense
was:
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
> .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
> Labels: .NET
> 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
> To do:
> * Remove {{Package-Info.cs}} files, they don't make sense
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)