Skip to content

Generate and tidy up XML docs for Core#4351

Merged
HebaruSan merged 1 commit into
KSP-CKAN:masterfrom
HebaruSan:feature/core-xml-docs
Apr 13, 2025
Merged

Generate and tidy up XML docs for Core#4351
HebaruSan merged 1 commit into
KSP-CKAN:masterfrom
HebaruSan:feature/core-xml-docs

Conversation

@HebaruSan
Copy link
Copy Markdown
Member

Motivation

Discord user Lewis has been coding against CKAN Core via the Nuget package. He has requested XML documentation be added to the package.

Changes

  • Now GenerateDocumentationFile is enabled for CKAN-core.csproj (the other projects aren't included in the .nupkg file)
  • The CS1591 warning for missing documentation is turned off so we don't have 3000+ new warnings every time we compile.
  • Assorted instances of other documentation related errors are fixed

This way, the next release will have XML docs embedded in the .nupkg.

@HebaruSan HebaruSan added Enhancement New features or functionality Easy This is easy to fix Core (ckan.dll) Issues affecting the core part of CKAN Documentation Issues affecting documentation labels Apr 13, 2025
@HebaruSan HebaruSan merged commit 40081c0 into KSP-CKAN:master Apr 13, 2025
2 checks passed
@HebaruSan HebaruSan deleted the feature/core-xml-docs branch April 13, 2025 03:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Core (ckan.dll) Issues affecting the core part of CKAN Documentation Issues affecting documentation Easy This is easy to fix Enhancement New features or functionality

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant