{"id":21474847,"url":"https://github.com/cbinet/autodocumentation","last_synced_at":"2025-07-15T09:31:51.914Z","repository":{"id":143868150,"uuid":"95324816","full_name":"CBinet/AutoDocumentation","owner":"CBinet","description":"Csharp to Markdown autodocumentation library.","archived":false,"fork":false,"pushed_at":"2017-09-12T23:01:03.000Z","size":9840,"stargazers_count":6,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-07-09T21:35:32.243Z","etag":null,"topics":["auto-generated","csharp","documentation","generated","markdown"],"latest_commit_sha":null,"homepage":"https://www.nuget.org/packages/BetaSoftware.AutoDocumentation","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CBinet.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-06-24T21:54:47.000Z","updated_at":"2023-12-06T20:32:38.000Z","dependencies_parsed_at":null,"dependency_job_id":"823159fa-69b2-49bb-b81c-940d2c96eade","html_url":"https://github.com/CBinet/AutoDocumentation","commit_stats":null,"previous_names":["cbinet/betasoftwares.autodocumentation"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/CBinet/AutoDocumentation","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CBinet%2FAutoDocumentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CBinet%2FAutoDocumentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CBinet%2FAutoDocumentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CBinet%2FAutoDocumentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CBinet","download_url":"https://codeload.github.com/CBinet/AutoDocumentation/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CBinet%2FAutoDocumentation/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265425316,"owners_count":23762899,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["auto-generated","csharp","documentation","generated","markdown"],"created_at":"2024-11-23T10:33:21.695Z","updated_at":"2025-07-15T09:31:51.902Z","avatar_url":"https://github.com/CBinet.png","language":null,"readme":"# AutoDocumentation\n\n## **Installation**\nTo install **AutoDocumentation**, you can either browse the Package Manager or run the following command in the \u003ca href='#https://docs.microsoft.com/fr-fr/nuget/tools/package-manager-console'\u003ePackage Manager Console\u003c/a\u003e :\n\n```\nPM\u003e Install-Package BetaSoftware.AutoDocumentation\n```\n\n\u003cbr\u003e \u003chr\u003e \u003cbr\u003e\n\n## **Usage**\nTo start using **AutoDocumentation**, simply call the GenerateDocumentation method of the **AutoDocumentation** class with the project assembly :\n\n```cs\nvar assembly = Assembly.LoadFrom(pathToDll); // Load the assembly.\nBetaSoftware.AutoDocumentation.GenerateDocumentation(assembly);\n```\nTo include all private and internal types in the generated documentation, call the GenerateDocumentation method with **false** as the second parameter :\n```cs\nvar assembly = Assembly.LoadFrom(pathToDll); // Load the assembly.\nBetaSoftware.AutoDocumentation.GenerateDocumentation(assembly, false);\n```\n\n### Settings attributes\nYou can customize the content that will appear in your generated documentation\nwith the **AutoDocumentation** attributes :\n\n#### AutoDocumentationIgnore\nAdd to exclude a type from documentation generation : \n\n```cs\n[AutoDocumentationIgnore]\npublic class IgnoredClass {\n    ...\n}\n```\n\n\u003cbr\u003e \u003chr\u003e \u003cbr\u003e\n\n## **Examples : Interface documentation**\n\n```cs\nnamespace DemoLibrary {\n\n    public interface IFormattable {\n\n        string FormatInformations();\n\n    }\n\n}\n```\n\n\u003ch2 id='IFormattableAnchor'\u003eDemoLibrary.IFormattable \u003c/h2\u003e   \u003ch3\u003eMethods : \u003c/h3\u003e\u003cstrong\u003epublic\u003c/strong\u003e \u003cstrong\u003e\u003c/strong\u003e \u003cstrong\u003eabstract\u003c/strong\u003e \u003cstrong\u003eString\u003c/strong\u003e FormatInformations()\u003cbr\u003e\n\n\u003cbr\u003e \u003chr\u003e \u003cbr\u003e\n\n## **Examples : Class  documentation**\n\n```cs\nnamespace DemoLibrary {\n\n    public class Employee : IFormattable {\n\n        public int Id;\n        public string Name;\n        public Address Address;\n        public Department Department;\n\n        public Employee(int pId, string pName, \n        Address address, Department department) {...}\n\n        public string FormatInformations() {...}\n\n    }\n\n}\n```\n\n\u003ch2 id='EmployeeAnchor'\u003eDemoLibrary.Employee : \u003ca href='#IFormattableAnchor'\u003eIFormattable\u003c/a\u003e\u003c/h2\u003e \u003ch3\u003eFields : \u003c/h3\u003e\u003cstrong\u003epublic\u003c/strong\u003e \u003cstrong\u003e\u003c/strong\u003e \u003cstrong\u003e\u003c/strong\u003e \u003cstrong\u003eInt32\u003c/strong\u003e Id\u003cbr\u003e \n\u003cstrong\u003epublic\u003c/strong\u003e \u003cstrong\u003e\u003c/strong\u003e \u003cstrong\u003e\u003c/strong\u003e \u003cstrong\u003eString\u003c/strong\u003e Name\u003cbr\u003e\n\u003cstrong\u003epublic\u003c/strong\u003e \u003cstrong\u003e\u003c/strong\u003e \u003cstrong\u003e\u003c/strong\u003e \u003cstrong\u003eAddress\u003c/strong\u003e Address\u003cbr\u003e\n\u003cstrong\u003epublic\u003c/strong\u003e \u003cstrong\u003e\u003c/strong\u003e \u003cstrong\u003e\u003c/strong\u003e \u003cstrong\u003eDepartment\u003c/strong\u003e Department\u003cbr\u003e \n \u003ch3\u003eConstructors : \u003c/h3\u003e\u003cstrong\u003epublic\u003c/strong\u003e \u003cstrong\u003e\u003c/strong\u003e Employee(\u003cstrong\u003eInt32\u003c/strong\u003e pId, \u003cstrong\u003eString\u003c/strong\u003e pName, \u003cstrong\u003eAddress\u003c/strong\u003e pAddress, \u003cstrong\u003eDepartment\u003c/strong\u003e pDepartment)\u003cbr\u003e \n \u003ch3\u003eMethods : \u003c/h3\u003e\u003cstrong\u003epublic\u003c/strong\u003e \u003cstrong\u003e\u003c/strong\u003e \u003cstrong\u003e\u003c/strong\u003e \u003cstrong\u003eString\u003c/strong\u003e FormatInformations()\u003cbr\u003e\n\n\u003cbr\u003e \u003chr\u003e \u003cbr\u003e\n\n## **Examples : Struct documentation**\n\n```cs\nnamespace DemoLibrary {\n\n    public struct Address {\n\n        public int DoorNumber;\n        public string StreetName;\n        public string City;\n        public string PostalCode;\n\n    }\n\n}\n```\n\n\u003ch2 id='AddressAnchor'\u003eDemoLibrary.Address \u003ch3\u003eFields : \u003c/h3\u003e\u003cstrong\u003epublic\u003c/strong\u003e \u003cstrong\u003e\u003c/strong\u003e \u003cstrong\u003e\u003c/strong\u003e \u003cstrong\u003eInt32\u003c/strong\u003e DoorNumber\u003cbr\u003e \n\u003cstrong\u003epublic\u003c/strong\u003e \u003cstrong\u003e\u003c/strong\u003e \u003cstrong\u003e\u003c/strong\u003e \u003cstrong\u003eString\u003c/strong\u003e StreetName\u003cbr\u003e \n\u003cstrong\u003epublic\u003c/strong\u003e \u003cstrong\u003e\u003c/strong\u003e \u003cstrong\u003e\u003c/strong\u003e \u003cstrong\u003eString\u003c/strong\u003e City\u003cbr\u003e \n\u003cstrong\u003epublic\u003c/strong\u003e \u003cstrong\u003e\u003c/strong\u003e \u003cstrong\u003e\u003c/strong\u003e \u003cstrong\u003eString\u003c/strong\u003e PostalCode\u003cbr\u003e \n\n\u003cbr\u003e \u003chr\u003e \u003cbr\u003e\n\n## **Examples : Enum documentation**\n\n```cs\nnamespace DemoLibrary {\n\n    public enum Department {\n\n        Sales,\n        Marketing,\n        HumanResources\n\n    }\n\n}\n```\n\n\u003ch2 id='DepartmentAnchor'\u003eDemoLibrary.Department\u003c/h2\u003e \u003ch4\u003eValues : \u003c/h4\u003e0 : \u003cstrong\u003eSales\u003c/strong\u003e, \u003cbr\u003e \n1 : \u003cstrong\u003eMarketing\u003c/strong\u003e, \u003cbr\u003e \n2 : \u003cstrong\u003eHumanResources\u003c/strong\u003e\u003cbr\u003e \n\n\u003cbr\u003e \u003chr\u003e \u003cbr\u003e\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcbinet%2Fautodocumentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcbinet%2Fautodocumentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcbinet%2Fautodocumentation/lists"}