Skip to content

Coding - Method guard iterative update#674

Merged
dpasukhi merged 2 commits into
Open-Cascade-SAS:IRfrom
dpasukhi:lxx_method_guards
Aug 15, 2025
Merged

Coding - Method guard iterative update#674
dpasukhi merged 2 commits into
Open-Cascade-SAS:IRfrom
dpasukhi:lxx_method_guards

Conversation

@dpasukhi
Copy link
Copy Markdown
Member

Used regex in src folder:
//[\s\n\r\t]==[=]+[\n\r]+//[\s\n\r\t][a-z]+[\s\n\r\t]:[\s\n\r\t][a-z0-9_:\t\s][\s\n\r\t]//[\s\n\r\t][a-z]+[\s\n\r\t]:([a-z0-9_\s\t./-><]){1,22}//[\s\n\r\t]===[=]+

Used regex in src folder:
//[\s\n\r\t]*==[=]+[\n\r]+//[\s\n\r\t]*[a-z]+[\s\n\r\t]*:[\s\n\r\t]*[a-z0-9_:\t\s]*[\s\n\r\t]//[\s\n\r\t]*[a-z]+[\s\n\r\t]*:([a-z0-9_\s\t./-><]){1,22}//[\s\n\r\t]*===[=]+
@dpasukhi dpasukhi requested a review from Copilot August 15, 2025 09:11
@dpasukhi dpasukhi self-assigned this Aug 15, 2025
@dpasukhi dpasukhi added the 1. Coding Coding rules, trivial changes and misprints label Aug 15, 2025
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR systematically updates comment block formatting for function/method headers throughout the modeling algorithms codebase. The change replaces traditional OpenCASCADE-style comment blocks with a simplified format.

  • Standardizes comment formatting by replacing detailed comment blocks with a uniform "//=================================================================================================" separator
  • Removes redundant "function:" and "purpose:" fields that often contained minimal or no useful information
  • Maintains code functionality while improving visual consistency across the codebase

Reviewed Changes

Copilot reviewed 259 out of 365 changed files in this pull request and generated no comments.

Show a summary per file
File Description
HLRBRep/*.lxx Updated inline function comment formatting in HLR boundary representation classes
HLRAlgo/*.lxx Updated inline function comment formatting in HLR algorithm classes
TopClass/*.lxx/.gxx Updated comment formatting in topological classification template classes
Intf/*.lxx/.gxx Updated comment formatting in interference detection classes
IntStart/*.gxx Updated comment formatting in intersection start classes
IntPatch/*.lxx Updated comment formatting in intersection patch classes
IntCurveSurface/*.gxx Updated comment formatting in curve-surface intersection classes
IntCurve/*.gxx Updated comment formatting in curve intersection classes
HatchGen/*.cxx Updated comment formatting in hatching generation classes
Hatch/*.lxx Updated comment formatting in hatching classes
GeomInt/*.lxx/.cxx Updated comment formatting in geometric intersection classes
GeomFill/*.lxx/.cxx Updated comment formatting in geometric filling classes
GeomAPI/*.lxx Updated comment formatting in geometric API classes
Geom2dHatch/*.lxx/.cxx Updated comment formatting in 2D hatching classes
Geom2dAPI/*.lxx Updated comment formatting in 2D geometric API classes
ApproxInt/*.gxx Updated comment formatting in approximation intersection classes
AppBlend/*.gxx Updated comment formatting in application blending classes
ChFiDS/*.lxx Updated comment formatting in chamfer/fillet data structure classes
ChFi2d/*.lxx Updated comment formatting in 2D chamfer/fillet classes
BRepFilletAPI/*.lxx Updated comment formatting in boundary representation fillet API classes
BRepBlend/*.lxx/.cxx Updated comment formatting in boundary representation blending classes
LocOpe/*.lxx Updated comment formatting in local operations classes

@github-project-automation github-project-automation Bot moved this from Todo to Integration in Maintenance Aug 15, 2025
@dpasukhi dpasukhi merged commit ae4de70 into Open-Cascade-SAS:IR Aug 15, 2025
45 of 46 checks passed
@dpasukhi dpasukhi deleted the lxx_method_guards branch August 15, 2025 16:14
@github-project-automation github-project-automation Bot moved this from Integration to Done in Maintenance Aug 15, 2025
@dpasukhi dpasukhi added this to the Release 8.0 milestone Aug 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

1. Coding Coding rules, trivial changes and misprints

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants