chore(quality): clean up stale XML doc comments

- Strip empty `<param name="X"></param>` tags whose corresponding
  parameter doesn't exist (or where the tag adds no doc value).
  Removes ~24 InvalidXmlDocComment findings.
- Fix malformed XML: escape literal `<T>` as `&lt;T&gt;` in three
  doc comments (HttpHelper, IamApi, UinformService); promote two
  `// <summary>` typos in IamApi to `///`; demote orphan `///`
  block on Program.cs SetAwsCredentials (top-level local function
  doesn't accept doc comments) to plain comment.
- Rename three orphan `<param>` tags to match real parameters
  (UserHelper.HasPermission, RAPSSecurityService.IsAllowedTo,
  VMACSExport.ExportToInstances).

Partial-coverage cases (methods with descriptive `<param>` tags
for some but not all parameters) intentionally left alone — their
existing documentation has real value, and selectively adding
empty tags or deleting good ones would be a net loss.

Author: rlorenzo

web/Areas/CMS/Data/CMS.cs

@@ -73,14 +73,6 @@ public CMS(VIPERContext viperContext, RAPSContext rapsContext, IHtmlSanitizerSer
         /// <summary>
         /// Get content blocks and filter based on permissions
         /// </summary>
-        /// <param name="contentBlockID"></param>
-        /// <param name="friendlyName"></param>
-        /// <param name="system"></param>
-        /// <param name="viperSectionPath"></param>
-        /// <param name="page"></param>
-        /// <param name="blockOrder"></param>
-        /// <param name="allowPublicAccess"></param>
-        /// <param name="status"></param>
         /// <returns>List of blocks</returns>
         public IEnumerable<ContentBlock>? GetContentBlocksAllowed(int? contentBlockID, string? friendlyName, string? system, string? viperSectionPath, string? page, int? blockOrder, bool? allowPublicAccess, int? status)
         {
@@ -128,14 +120,6 @@ public CMS(VIPERContext viperContext, RAPSContext rapsContext, IHtmlSanitizerSer
         /// <summary>
         /// Get content blocks without filtering on permissions
         /// </summary>
-        /// <param name="contentBlockID"></param>
-        /// <param name="friendlyName"></param>
-        /// <param name="system"></param>
-        /// <param name="viperSectionPath"></param>
-        /// <param name="page"></param>
-        /// <param name="blockOrder"></param>
-        /// <param name="allowPublicAccess"></param>
-        /// <param name="status"></param>
         /// <returns>List of blocks</returns>
         public IEnumerable<ContentBlock>? GetContentBlocks(int? contentBlockID = null, string? friendlyName = null, string? system = null,
             string? viperSectionPath = null, string? page = null, int? blockOrder = null,
@@ -188,12 +172,6 @@ private void SanitizeContentBlocks(IEnumerable<ContentBlock> blocks)
         /// <summary>
         /// Returns the first file that matches the parameters past (or null)
         /// </summary>
-        /// <param name="fileGUID"></param>
-        /// <param name="oldURL"></param>
-        /// <param name="friendlyName"></param>
-        /// <param name="folder"></param>
-        /// <param name="name"></param>
-        /// <param name="getDeleted"></param>
         /// <returns>File object</returns>
         public CMSFile? GetFile(string? fileGUID, string? oldURL, string? friendlyName, string? folder, string? name)
         {
@@ -288,12 +266,6 @@ private void SanitizeContentBlocks(IEnumerable<ContentBlock> blocks)
         /// <summary>
         /// Search for matching files
         /// </summary>
-        /// <param name="folder"></param>
-        /// <param name="isPublic"></param>
-        /// <param name="search"></param>
-        /// <param name="status"></param>
-        /// <param name="encrypted"></param>
-        /// <returns></returns>
         public IEnumerable<CMSFile> GetAllFiles(string? folder, bool? isPublic, string? search, string? status, bool? encrypted)
         {
 
@@ -337,9 +309,6 @@ public IEnumerable<CMSFile> GetAllFiles(string? folder, bool? isPublic, string?
         /// <summary>
         /// Get Friendly URL for a friendly name. Currently, always points to ColdFusion Viper
         /// </summary>
-        /// <param name="friendlyName"></param>
-        /// <param name="allowPublicAccess"></param>
-        /// <returns></returns>
         public static string GetFriendlyURL(string friendlyName, bool allowPublicAccess = false)
         {
             string rootURL = String.Empty;
@@ -359,9 +328,6 @@ public static string GetFriendlyURL(string friendlyName, bool allowPublicAccess
         /// <summary>
         /// Get url for a fileGUID
         /// </summary>
-        /// <param name="fileGUID"></param>
-        /// <param name="allowPublicAccess"></param>
-        /// <returns></returns>
         public static string GetURL(string fileGUID, bool allowPublicAccess = false)
         {
             return (allowPublicAccess ? @"/public" : "") + @"/cms/files/?id=" + fileGUID;
@@ -372,7 +338,6 @@ public static string GetURL(string fileGUID, bool allowPublicAccess = false)
         /// <summary>
         /// Get the root folder for files
         /// </summary>
-        /// <returns></returns>
         public static string GetRootFileFolder()
         {
             if (HttpHelper.Environment?.EnvironmentName == "Development")
@@ -388,7 +353,6 @@ public static string GetRootFileFolder()
         /// <summary>
         /// Replace the root folder in a file object, e.g. if the app is on secure-test but the file was added on a dev machine, or vice versa.
         /// </summary>
-        /// <param name="file"></param>
         public static void ReplaceRootFolder(CMSFile file)
         {
             string filePath = file.FilePath;
@@ -407,8 +371,6 @@ public static void ReplaceRootFolder(CMSFile file)
         /// <summary>
         /// Remove root folder in the file path and change path separator to /
         /// </summary>
-        /// <param name="filePath"></param>
-        /// <returns></returns>
         public string FilePathToWebPath(string filePath)
         {
             return filePath.Replace(GetRootFileFolder(), "").Replace(@"\", @"/");
@@ -648,8 +610,6 @@ public byte[] DecryptFile(byte[] encryptedData, string keystring)
         /// <summary>
         /// Required for Unix decoding FROM https://rextester.com/TGN19503
         /// </summary>
-        /// <param name="encryptedString"></param>
-        /// <param name="Key"></param>
         /// <returns>decoded string</returns>
         public string DecryptAES(string encryptedString, string Key)
         {

web/Areas/CTS/Controllers/AssessmentController.cs

@@ -32,14 +32,6 @@ public AssessmentController(VIPERContext _context, RAPSContext rapsContext, CtsS
         /// <summary>
         /// Generic assessment get with params - note that this returns StudentAssessments of derived types
         /// </summary>
-        /// <param name="type"></param>
-        /// <param name="studentUserId"></param>
-        /// <param name="enteredById"></param>
-        /// <param name="serviceId"></param>
-        /// <param name="epaId"></param>
-        /// <param name="dateFrom"></param>
-        /// <param name="dateTo"></param>
-        /// <returns></returns>
         [HttpGet]
         [Permission(Allow = "SVMSecure.CTS.Manage,SVMSecure.CTS.StudentAssessments,SVMSecure.CTS.AssessClinical,SVMSecure.CTS.MyAssessments")]
         [ApiPagination(DefaultPerPage = 100, MaxPerPage = 100)]
@@ -193,8 +185,6 @@ public async Task<ActionResult<List<Assessor>>> GetAssessors(int? type, int? ser
         /// <summary>
         /// Get single student epa assessment
         /// </summary>
-        /// <param name="encounterId"></param>
-        /// <returns></returns>
         [HttpGet("{encounterId}")]
         [Permission(Allow = "SVMSecure.CTS.Manage,SVMSecure.CTS.StudentAssessments,SVMSecure.CTS.AssessClinical,SVMSecure.CTS.MyAssessments")]
         public async Task<ActionResult<StudentAssessment>> GetStudentAssessment(int encounterId)
@@ -224,8 +214,6 @@ public async Task<ActionResult<StudentAssessment>> GetStudentAssessment(int enco
         /// Given an Eval360 instance id, get the list of student evalautees for this evaluator and whether or not they have an EPA during
         /// this rotation.
         /// </summary>
-        /// <param name="instanceId"></param>
-        /// <returns></returns>
         [HttpGet("epacompletion")]
         [Permission(Allow = "SVMSecure")]
         public async Task<ActionResult<List<EvaluateeWithEpaCompletion>>> EvalauteeStudentsWithEpas(int instanceId)
@@ -286,8 +274,6 @@ public async Task<ActionResult<List<EvaluateeWithEpaCompletion>>> EvalauteeStude
         /// <summary>
         /// Create a new epa assessment
         /// </summary>
-        /// <param name="epaData"></param>
-        /// <returns></returns>
         [HttpPost("epa")]
         [Permission(Allow = "SVMSecure.CTS.AssessClinical,SVMSecure.CTS.Manage")]
         public async Task<ActionResult<CreateUpdateStudentEpa>> CreateStudentEpa(CreateUpdateStudentEpa epaData)
@@ -331,9 +317,6 @@ public async Task<ActionResult<CreateUpdateStudentEpa>> CreateStudentEpa(CreateU
         /// <summary>
         /// Update an EPA
         /// </summary>
-        /// <param name="encounterId"></param>
-        /// <param name="epaData"></param>
-        /// <returns></returns>
         [HttpPut("epa/{encounterId}")]
         [Permission(Allow = "SVMSecure.CTS.AssessClinical,SVMSecure.CTS.Manage")]
         public async Task<ActionResult<CreateUpdateStudentEpa>> UpdateStudentEpa(int encounterId, CreateUpdateStudentEpa epaData)

web/Areas/CTS/Controllers/ClinicalScheduleController.cs

@@ -27,14 +27,6 @@ public ClinicalScheduleController(IClinicalScheduleService scheduleService, ISch
         /// <summary>
         /// Get student schedule. Access should be restricted to admins, ViewStdSchedules, and students viewing their own schedule.
         /// </summary>
-        /// <param name="classYear"></param>
-        /// <param name="mothraId"></param>
-        /// <param name="rotationId"></param>
-        /// <param name="serviceId"></param>
-        /// <param name="weekId"></param>
-        /// <param name="startDate"></param>
-        /// <param name="endDate"></param>
-        /// <returns></returns>
         [HttpGet("student")]
         public async Task<ActionResult<List<ClinicalScheduledStudent>>> GetStudentSchedule(int? classYear, string? mothraId, int? rotationId, int? serviceId,
             int? weekId, DateTime? startDate, DateTime? endDate)
@@ -50,13 +42,6 @@ public async Task<ActionResult<List<ClinicalScheduledStudent>>> GetStudentSchedu
         /// <summary>
         /// Get instructor schedule. Access should be restricted to admins, ViewClnSchedules, and instructors viewing their own schedule.
         /// </summary>
-        /// <param name="classYear"></param>
-        /// <param name="mothraId"></param>
-        /// <param name="serviceId"></param>
-        /// <param name="weekId"></param>
-        /// <param name="startDate"></param>
-        /// <param name="endDate"></param>
-        /// <returns></returns>
         [HttpGet("instructor")]
         public async Task<ActionResult<List<InstructorSchedule>>> GetInstructorSchedule(int? classYear, string? mothraId, int? rotationId, int? serviceId,
                 int? weekId, DateTime? startDate, DateTime? endDate, bool active = true)

web/Areas/CTS/Services/AuditService.cs

@@ -26,11 +26,6 @@ public AuditService(VIPERContext context)
         /// <summary>
         /// Audit the creation, update, or delete of a student EPA assessment
         /// </summary>
-        /// <param name="encounter"></param>
-        /// <param name="studentEpa"></param>
-        /// <param name="actionType"></param>
-        /// <param name="modifier"></param>
-        /// <returns></returns>
         public async Task AuditStudentEpa(Encounter encounter, AuditActionType actionType, int modifier)
         {
             var details = JsonSerializer.Serialize(new

web/Areas/CTS/Services/CrestCourseService.cs

@@ -18,10 +18,6 @@ public CrestCourseService(VIPERContext context)
         /// <summary>
         /// Get Courses for year, or by course number or subject code
         /// </summary>
-        /// <param name="academicYear"></param>
-        /// <param name="courseNum"></param>
-        /// <param name="subjectCode"></param>
-        /// <returns></returns>
         public async Task<List<Course>> GetCourses(string? termCode, string? courseNum, string? subjectCode)
         {
             var cso = await GetCourseSessionOffering(academicYear: termCode, courseNum: courseNum, subjectCode: subjectCode);
@@ -31,8 +27,6 @@ public async Task<List<Course>> GetCourses(string? termCode, string? courseNum,
         /// <summary>
         /// Get a single course + sessions and offerings
         /// </summary>
-        /// <param name="courseId"></param>
-        /// <returns></returns>
         public async Task<Course?> GetCourse(int courseId)
         {
             var cso = await GetCourseSessionOffering(courseId: courseId);
@@ -42,8 +36,6 @@ public async Task<List<Course>> GetCourses(string? termCode, string? courseNum,
         /// <summary>
         /// Get a single session and offerings
         /// </summary>
-        /// <param name="sessionId"></param>
-        /// <returns></returns>
         public async Task<Session?> GetSession(int sessionId)
         {
             var cso = await GetCourseSessionOffering(sessionId: sessionId);
@@ -53,8 +45,6 @@ public async Task<List<Course>> GetCourses(string? termCode, string? courseNum,
         /// <summary>
         /// Gets sessions for a course and their offerings
         /// </summary>
-        /// <param name="courseId"></param>
-        /// <returns></returns>
         public async Task<List<Session>> GetSessions(int courseId)
         {
             var course = await GetCourse(courseId);
@@ -68,8 +58,6 @@ public async Task<List<Session>> GetSessions(int courseId)
         /// <summary>
         /// Turn a list of CourseSessionOfferings into a list of Course objects
         /// </summary>
-        /// <param name="csos"></param>
-        /// <returns></returns>
         static private List<Course> CourseSessionOfferingsToCourses(List<CourseSessionOffering> csos)
         {
             List<Course> courses = new();
@@ -87,8 +75,6 @@ static private List<Course> CourseSessionOfferingsToCourses(List<CourseSessionOf
         /// <summary>
         /// Turn a list of CourseSessionOfferings, all from the same course, into a list of sessions for that course
         /// </summary>
-        /// <param name="csos"></param>
-        /// <returns></returns>
         static private List<Session> CourseSessionOfferingsToSessions(List<CourseSessionOffering> csos)
         {
             List<Session> sessions = new();
@@ -106,8 +92,6 @@ static private List<Session> CourseSessionOfferingsToSessions(List<CourseSession
         /// <summary>
         /// Turn a list of CourseSessionOfferings, all from the same session, into a list of offerings for that session
         /// </summary>
-        /// <param name="csos"></param>
-        /// <returns></returns>
         static private List<Offering> CourseSessionOfferingsToOfferings(List<CourseSessionOffering> csos)
         {
             List<Offering> offerings = new();
@@ -121,16 +105,6 @@ static private List<Offering> CourseSessionOfferingsToOfferings(List<CourseSessi
         /// <summary>
         /// Get a list CourseSessionOffering objects from the database
         /// </summary>
-        /// <param name="academicYear"></param>
-        /// <param name="courseNum"></param>
-        /// <param name="subjectCode"></param>
-        /// <param name="crn"></param>
-        /// <param name="sessionType"></param>
-        /// <param name="room"></param>
-        /// <param name="from"></param>
-        /// <param name="to"></param>
-        /// <param name="studentGroup"></param>
-        /// <returns></returns>
         private async Task<List<CourseSessionOffering>> GetCourseSessionOffering(
             int? courseId = null, string? academicYear = null, string? courseNum = null, string? subjectCode = null,
             string? crn = null, int? sessionId = null, string? sessionType = null,

web/Areas/CTS/Services/CtsSecurityService.cs

@@ -28,9 +28,6 @@ public CtsSecurityService(RAPSContext rapsContext, VIPERContext viperContext, IU
         ///     Assessors can view assessments they've entered
         ///     Managers can view all assessments
         /// </summary>
-        /// <param name="studentId"></param>
-        /// <param name="enteredBy"></param>
-        /// <returns></returns>
         public bool CheckStudentAssessmentViewAccess(int? studentId = null, int? enteredBy = null, int? serviceId = null)
         {
             var currentUser = userHelper.GetCurrentUser();

web/Areas/Directory/Controllers/DirectoryController.cs

@@ -54,7 +54,6 @@ public async Task<ActionResult<IEnumerable<NavMenuItem>>> Nav()
         /// Directory list
         /// </summary>
         /// <param name="search">search string</param>
-        /// <returns></returns>
         [SupportedOSPlatform("windows")]
         [Route("/[area]/search/{search}")]
         public async Task<ActionResult<IEnumerable<IndividualSearchResult>>> Get(string search)
@@ -99,7 +98,6 @@ public async Task<ActionResult<IEnumerable<IndividualSearchResult>>> Get(string
         /// Directory list
         /// </summary>
         /// <param name="search">search string</param>
-        /// <returns></returns>
         [SupportedOSPlatform("windows")]
         [Route("/[area]/search/{search}/ucd")]
         public async Task<ActionResult<IEnumerable<IndividualSearchResult>>> GetUCD(string search)
@@ -145,7 +143,6 @@ public async Task<ActionResult<IEnumerable<IndividualSearchResult>>> GetUCD(stri
         /// Directory results
         /// </summary>
         /// <param name="uid">User ID</param>
-        /// <returns></returns>
         [Route("/[area]/userInfo/{mothraID}")]
         public async Task<IActionResult> DirectoryResult(string mothraID)
         {

web/Areas/RAPS/Controllers/MembersController.cs

@@ -93,7 +93,6 @@ public async Task<ActionResult<MemberSearchResult>> Get(string memberId)
         /// Get all permissions assigned to a user (either allowed or denied) based on either role membership or direct
         /// permission assignment.
         /// </summary>
-        /// <param name="memberId"></param>
         /// <returns>A list of permission results, including a source param to determine how the permission was assigned</returns>
         [Permission(Allow = "RAPS.Admin,RAPS.RSOP")]
         [HttpGet("{memberId}/RSOP")]