Uploaded image for project: 'Ignite'
  1. Ignite
  2. IGNITE-6253

.NET: Replace Doxygen with DocFX for API documentation generation

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Resolved
    • Major
    • Resolution: Fixed
    • None
    • 2.3
    • documentation, platforms

    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 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

      Attachments

        Issue Links

          Activity

            People

              ptupitsyn Pavel Tupitsyn
              ptupitsyn Pavel Tupitsyn
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: