Add XML documentation to ModuleHelper class#45376
Conversation
Fixes #45364 This adds comprehensive XML documentation comments following Microsoft documentation standards for all public methods.
There was a problem hiding this comment.
Pull request overview
Adds a new header intended to document a ModuleHelper class, but the implementation does not align with the PR description/linked issue (which target XML docs on the C# Settings.UI.Library ModuleHelper).
Changes:
- Added
src/common/modules/ModuleHelperDocs.hcontaining XML-style doc comments and a C++ModuleHelperclass declaration.
yeelam-gordon
left a comment
There was a problem hiding this comment.
PR Review — #45376
Review completed with 2 high and 4 medium severity findings.
Core concern: This PR adds a C++ header (src/common/modules/ModuleHelperDocs.h) declaring a ModuleHelper class with methods that don't exist in the codebase. The actual ModuleHelper is a C# class at src/settings-ui/Settings.UI.Library/Helpers/ModuleHelper.cs with entirely different methods. The file is also placed in a non-existent directory and is not referenced by any build project.
See individual line comments below for details.
Summary
Adds comprehensive XML documentation comments to the ModuleHelper class.
Fixes
Fixes #45364
Changes
ModuleHelperDocs.hwith documented ModuleHelper classDocumentation covers:
Initialize- Module initializationLoadSettings- Settings loading from registry/fileValidate- State validationCleanup- Resource cleanup