/DocsMaster

Primary LanguageC#GNU General Public License v3.0GPL-3.0

📝 DocsMaster 📝

General Info

Origin
This repository contains software developed as one of the projects during internship at Millennium Bank

Goal
Main goal of this project is to generate documentation from source code and comments in XML format

How it works ?
Engine, through the CodeAnalysis library, analyzes the source code of all the projects loaded in the soluition. And then writes the documentation to files according to the user's preferences

Notice
Software is in the early stages of development. Therefore, errors may occur during its operations. For reporting them, thank you very much

License
GNU GPL v3.0


Installation

Work in progress - installation file is currently unavailable


How to use

How to run
In the Visual Studio toolbar, select the Tools tab, and then press the Generate Documentation button

Where to find documentation
When the VSIX is first launched, a "docs" folder will be created in the directory containing the .sln file

How to change settings
There is a config.json file in the documentation folder. Which contains all currently available settings.

What formats are currently available
So far the supported formats are:

  • md
  • xml