RefDocGen - Reference Documentation Generator for .NET

Abstract

This thesis aimed to create a reference documentation generator for .NET that satisfies various requirements derived from an analysis of use cases and existing solutions. The program is distributed as a .NET command-line tool that is easy to use, requiring only a single mandatory argument: the assembly, project, or solution to be documented. It uses the data from the provided assembly and its associated XML documentation file to create the documentation. The default UI is modern-looking and renders all standard XML documentation tags accordingly. The generator is designed to be extensible, allowing users to define custom templates. Additionally, the program supports including custom pages in the documentation, which makes it easy to provide, for example, a custom index page. Furthermore, documentation versioning is supported as well.

Cílem této práce bylo vytvořit generátor referenční dokumentace pro .NET, který splňuje různé požadavky vyplývající z analýzy scénářů použití a již existujících řešení. Program je distribuován jako .NET nástroj ovládaný pomocí příkazového řádku. Použití generátoru je snadné, jelikož vyžaduje pouze jeden povinný argument: assembly, projekt nebo solution, jehož dokumentaci chceme vygenerovat. Pro vytvoření dokumentace jsou použita data z poskytnutého assembly a přidruženého souboru s XML dokumentací. Vý- chozí uživatelské rozhraní má moderní design a podporuje všechny standardně používané XML tagy. Generátor je navržen tak, aby byl rozšiřitelný, což uživatelům umožňuje de- finovat vlastní šablony. Program dále podporuje přidání vlastních stránek, např. index stránky, do dokumentace, a také verzování dokumentace.