Merged
Conversation
mitchelsellers
approved these changes
Apr 29, 2025
2f5e957 to
ced700f
Compare
valadas
approved these changes
Apr 30, 2025
ced700f to
c965561
Compare
Parameter documentation must match the parameters
A C# method, constructor, delegate or indexer element is missing documentation for one or more of its parameters.
The <summary> tag within an element's Xml header documentation contains the default text generated by Visual Studio during the creation of the element.
The <summary> tag within the documentation header for a C# code element is empty.
The <summary> or <content> tag within the documentation header for a C# code element is missing or empty.
The Xml header documentation for a C# element is missing a <summary> tag. Platform/DotNetNuke.Web/UI/WebControls/Internal/DnnFormToggleButtonItem.cs Platform/DotNetNuke.Web/UI/WebControls/Internal/DnnGridTemplateColumn.cs
An item within a C# enumeration is missing an Xml documentation header.
A C# partial element is missing a documentation header.
A <param> tag within a C# element's documentation header is empty.
A C# method, constructor, delegate or indexer element is missing documentation for one or more of its parameters. Dnn.AdminExperience/Dnn.PersonaBar.Extensions/Services/SecurityController.cs Platform/DotNetNuke.Web.Mvc/Framework/ActionFilters/AuthorizeAttributeBase.cs Platform/Providers/FolderProviders/DotNetNuke.Providers.FolderProviders.csproj Platform/Website/DesktopModules/Admin/EditExtension/EditExtension.ascx.cs Platform/Website/DesktopModules/Admin/Security/ProfileDefinitions.ascx.cs Dnn.AdminExperience/Dnn.PersonaBar.Extensions/Components/Pages/ICloneModuleExecutionContext.cs Dnn.AdminExperience/Dnn.PersonaBar.Extensions/Components/Security/Utility.cs Dnn.AdminExperience/Dnn.PersonaBar.Extensions/Dnn.PersonaBar.Extensions.csproj Dnn.AdminExperience/Dnn.PersonaBar.Extensions/Services/ExtensionsController.cs Dnn.AdminExperience/Dnn.PersonaBar.Extensions/Services/SecurityController.cs Dnn.AdminExperience/Dnn.PersonaBar.Extensions/Services/UsersController.cs Dnn.AdminExperience/Dnn.PersonaBar.Extensions/Services/VocabulariesController.cs Dnn.AdminExperience/EditBar/Dnn.EditBar.UI/Services/LocalizationController.cs Dnn.AdminExperience/Library/Dnn.PersonaBar.Library/Controllers/IPersonaBarUserSettingsController.cs Dnn.AdminExperience/Library/Dnn.PersonaBar.Library/Dnn.PersonaBar.Library.csproj Dnn.AdminExperience/Library/Dnn.PersonaBar.Library/Repository/IPersonaBarExtensionRepository.cs Dnn.AdminExperience/Library/Dnn.PersonaBar.UI/Services/LocalizationController.cs Dnn.AdminExperience/Library/Dnn.PersonaBar.UI/Services/TabsController.cs Dnn.AdminExperience/Library/Dnn.PersonaBar.UI/Services/UserSettingsController.cs
A generic C# element is missing documentation for one or more of its generic type parameters.
A C# element is missing documentation for its return value.
A C# code file is missing a standard file header.
The <summary> or <content> tag within the documentation header for a C# code element is empty.
A C# partial element is missing a documentation header. Platform/DotNetNuke.Web/InternalServices/ContentWorkflowServiceController.cs Platform/Modules/MemberDirectory/DotNetNuke.Modules.MemberDirectory.csproj Platform/Modules/MemberDirectory/ViewModels/MemberDirectorySettingsModel.cs Platform/Website/DesktopModules/Admin/SearchResults/ResultsSettings.ascx.cs Platform/Website/DesktopModules/Admin/SearchResults/SearchResults.ascx.cs Platform/Website/DesktopModules/Admin/UrlManagement/UrlProviderSettings.ascx.cs Platform/Website/DesktopModules/AuthenticationServices/DNN/Settings.ascx.cs Dnn.AdminExperience/Dnn.PersonaBar.Extensions/Components/Pages/PagesController.cs Dnn.AdminExperience/Dnn.PersonaBar.Extensions/Components/Prompt/IModulesController.cs Dnn.AdminExperience/Dnn.PersonaBar.Extensions/Components/Prompt/Models/Command.cs Dnn.AdminExperience/Dnn.PersonaBar.Extensions/Components/Prompt/Models/CommandHelp.cs Dnn.AdminExperience/Dnn.PersonaBar.Extensions/Components/Prompt/Models/CommandOption.cs Dnn.AdminExperience/Dnn.PersonaBar.Extensions/Components/Prompt/ModulesController.cs Dnn.AdminExperience/Dnn.PersonaBar.Extensions/Components/Prompt/Repositories/CommandRepository.cs Dnn.AdminExperience/Dnn.PersonaBar.Extensions/Components/Prompt/Repositories/ICommandRepository.cs Dnn.AdminExperience/Dnn.PersonaBar.Extensions/Components/SqlConsole/SqlConsoleQuery.cs Dnn.AdminExperience/Dnn.PersonaBar.Extensions/Components/Users/Prompt/Utilities.cs Dnn.AdminExperience/Dnn.PersonaBar.Extensions/Dnn.PersonaBar.Extensions.csproj Dnn.AdminExperience/Library/Dnn.PersonaBar.Library/Dnn.PersonaBar.Library.csproj Dnn.AdminExperience/Library/Dnn.PersonaBar.Library/Helper/PortalHelper.cs Dnn.AdminExperience/Library/Dnn.PersonaBar.Library/Prompt/Attributes/ConsoleCommandAttribute.cs Dnn.AdminExperience/Library/Dnn.PersonaBar.Library/Prompt/ConsoleCommandBase.cs Dnn.AdminExperience/Library/Dnn.PersonaBar.Library/Prompt/IConsoleCommand.cs Dnn.AdminExperience/Library/Dnn.PersonaBar.Library/Prompt/Models/ConsoleErrorResultModel.cs Dnn.AdminExperience/Library/Dnn.PersonaBar.Library/Prompt/Models/PagingInfo.cs Dnn.AdminExperience/Library/Dnn.PersonaBar.UI/admin/personaBar/UserControls/PersonaBarContainer.ascx.cs
c965561 to
e0d568d
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR resolves a number of StyleCop documentation issues and begins treating those warnings as errors.