Skip to content

A library that leverages reflection to generate documentation for classes in their original declaration format.

License

Notifications You must be signed in to change notification settings

VelSkorp/ReflectionDocumenter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ReflectionDocumenter

ReflectionDocumenter is a .NET library designed to create detailed documentation for your .NET classes. It uses reflection to create documentation for classes in their original declaration format.

Screenshots

Working example

Home Page

Features

  • Creates documentation for classes in their original declaration format.
  • Contains ExampleClass to demonstrate the usage of Reflection Documenter. It contains various types of members.

Getting Started

Installation

  1. Clone the repository:
git clone https://github.com/VelSkorp/ReflectionDocumenter.git
cd ReflectionDocumenter
  1. Build the project:
dotnet build

Usage

  1. Add a reference to ReflectionDocumenter in your project.

  2. Import the ReflectionDocumenter namespace in your code:

using ReflectionDocumenter;
  1. Use the ReflectedClassInfo class to generate documentation for your assemblies:
var classInfo = new ReflectedClassInfo();
var classDefinition = classInfo.GetClassDefinition(typeof(ExampleClass<int, string>));
Console.WriteLine(classDefinition);

Replace ExampleClass<int, string> with the class you want to get information about.

Contributing

Contributions to SimpleGraphics are welcome! If you find any issues or have ideas for improvements, feel free to open an issue or submit a pull request on GitHub.

License

This project is licensed under the MIT License - see the LICENSE file for details.

About

A library that leverages reflection to generate documentation for classes in their original declaration format.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages