Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion .editorconfig
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
root = true

file_header_template = Copyright (C) 2025 Kampute\n\nReleased under the terms of the MIT license.\nSee the LICENSE file in the project root for the full license text.
file_header_template = Copyright (C) Kampute\n\nReleased under the terms of the MIT license.\nSee the LICENSE file in the project root for the full license text.

[*.{cs,vb}]
indent_size = 4
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (C) 2025 Kampute
Copyright (C) Kampute

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
2 changes: 2 additions & 0 deletions docs/welcome.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[![Version](https://img.shields.io/github/v/release/kampute/doc-toolkit?label=Version&color=darkred)](https://github.com/kampute/doc-toolkit/releases)

# Welcome to DocToolkit

DocToolkit is a .NET library that extracts metadata from .NET assemblies and transforms XML documentation comments into structured documentation models. Unlike traditional documentation generators that produce fixed output, DocToolkit provides the building blocks for creating custom documentation systems tailored to your specific needs.
Expand Down
3 changes: 2 additions & 1 deletion kampose.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@
"projectLogoLightUri": "logo-dark.png",
"projectLogoDarkUri": "logo-light.png",
"faviconUri": "ICON.png",
"pageFooter": "- Copyright © {{now 'yyyy'}} [Kampute](https://kampute.com)\n- Site built with [Kampose](https://kampute.github.io/kampose/).",
"pageFooter": "Copyright © {{now 'yyyy'}} [Kampute](https://kampute.com)",
"pageFooterRight": "Built with [Kampose](https://kampute.github.io/kampose/)",
"groupTypesByNamespace": true,
"showTypeMembersSummary": true,
"seeAlsoSubtopics": true,
Expand Down
2 changes: 1 addition & 1 deletion src/Collections/IReadOnlyPatternCollection.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/Collections/IReadOnlyTopicCollection.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/Collections/IReadOnlyTypeCollection.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/Collections/NamespaceDoc.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/Collections/OverloadCollection.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/Collections/PatternCollection.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/Collections/TopicCollection.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/DevOpsWikiOptions.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/DevOpsWikiStrategy.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/DocFxOptions.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/DocFxStrategy.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/DocumentPageRenderer.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/DocumentationComposer.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/DocumentationContext.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/DocumentationContextBuilder.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/DocumentationContextExtensions.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/DocumentationModelType.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/DotNetApiOptions.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/DotNetApiStrategy.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/FileSystemDocumentWriterFactory.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/FileSystemDocumentationComposer.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/FileTopicFactory.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/Formatters/DocFormatProvider.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/Formatters/DocFormatter.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/Formatters/HtmlFormat.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/Formatters/HtmlLinkTransformer.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/Formatters/IDocumentFormatter.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/Formatters/ITextEncoder.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/Formatters/ITextTransformer.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/Formatters/IdentityTransformer.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/Formatters/MarkdownFormat.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/Formatters/MarkdownLinkTransformer.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/Formatters/NamespaceDoc.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/Formatters/TextTransformerRegistry.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/IDocumentModel.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/IDocumentRenderer.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/IDocumentWriterFactory.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/IDocumentationContext.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/IO/Minifiers/HtmlMinifier.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/IO/Minifiers/MarkdownMinifier.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/IO/Minifiers/NamespaceDoc.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/IO/NamespaceDoc.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/IO/Writers/HtmlWriter.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/IO/Writers/MarkdownWriter.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/IO/Writers/MarkupWriter.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/IO/Writers/NamespaceDoc.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/IO/Writers/UrlContextAwareWriter.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/IO/Writers/WrappedTextWriter.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/Kampute.DocToolkit.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<Version>2.2.0</Version>
<Company>Kampute</Company>
<Authors>Kambiz Khojasteh</Authors>
<Copyright>Copyright (c) 2025 Kampute</Copyright>
<Copyright>Copyright (C) Kampute</Copyright>
<LangVersion>latest</LangVersion>
<Nullable>enable</Nullable>
<EnableNETAnalyzers>True</EnableNETAnalyzers>
Expand Down
2 changes: 1 addition & 1 deletion src/Languages/CSharp.Data.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/Languages/CSharp.Literals.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/Languages/CSharp.TypeMembers.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/Languages/CSharp.Types.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/Languages/CSharp.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/Languages/CodeStyleOptions.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/Languages/IProgrammingLanguage.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/Languages/Language.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/Languages/LanguageExtensions.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/Languages/MemberDocLinker.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
2 changes: 1 addition & 1 deletion src/Languages/NameQualifier.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2025 Kampute
// Copyright (C) Kampute
//
// Released under the terms of the MIT license.
// See the LICENSE file in the project root for the full license text.
Expand Down
Loading