Repository navigation
Conversation
The Westwood comment blocks above the functions in WWLib and WWDebug are replaced by slim // comments. Descriptions are kept where they add to the function name. INPUT and OUTPUT entries are dropped unless they say something the signature does not, such as a nullptr return. History entries are dropped, except for notes on how a function behaves today. The Functions lists in the file headers are removed as well, since they repeat the function descriptions.
The Westwood comment blocks above the functions are replaced by slim // comments. Descriptions are kept where they add to the function name. INPUT and OUTPUT entries are dropped unless they say something the signature does not, such as units or valid ranges. History entries are dropped, except for notes on how a function behaves today and the TheSuperHackers entries, which keep their keyword. The Functions lists in the file headers are removed as well, since they repeat the function descriptions.
The Westwood comment blocks above the functions are replaced by slim // comments. Descriptions are kept where they add to the function name. INPUT and OUTPUT entries are dropped unless they say something the signature does not, such as units or special values. History entries are dropped, except for notes on how a function behaves today and the TheSuperHackers entries, which keep their keyword. The Functions lists in the file headers are removed as well, since they repeat the function descriptions.
… Hour The Westwood comment blocks above the functions in the WW3D2 files of Generals and Zero Hour are replaced by slim // comments, following the same rules as in Core. Functions that exist in both games get identical comments, including where the original blocks differed only in spelling or history entries. The Functions lists in the file headers are removed as well.
The Westwood comment blocks above the functions in max2w3d, Autorun, mangler, matchbot, Launcher, PATCHGET and GameNetwork are replaced by slim // comments, following the same rules as in the libraries. Functions that also exist in WW3D2 or in both games get identical comments. The Functions lists in the file headers are removed as well.
The Westwood file headers of WWAudio, W3DView, wdump and a few W3DDevice files still carry a Functions section, which is empty in all of them. It is removed like the function lists in the other files, keeping the rest of the header.
|
Important Review skippedToo many files! This PR contains 654 files, which is 504 over the limit of 150. To get a review, reduce the PR to 150 files or fewer by splitting it into smaller PRs or changing its base branch. Upgrade to a paid plan to raise the limit. Usage-priced reviews support at most 300 files.
|
[Low impact] This comment-only cleanup appears safe to merge.
|
stephanmeesters
left a comment
There was a problem hiding this comment.
LGTM
Could perhsps benefit from one more filtering pass
Skyaero42
left a comment
There was a problem hiding this comment.
This needs another pass.
- The PR is inconsistent in moving the function description into a simple comment.
- When there is input/output/warning present, simple comment is skipping the actual method description.
| * HISTORY: * | ||
| * 1/26/00 gth : Created. * | ||
| *=============================================================================================*/ | ||
| // WARNING: Hopefully you won't use more than 4 billion decals at one time... |
There was a problem hiding this comment.
This is intentional. I asked Claude to omit the description if it just repeats what the function name already says anyway.
There was a problem hiding this comment.
And leaving this warning is helpful how?
There was a problem hiding this comment.
It just followed the rules. If we want to spend more time polishing the comments we can do it, but it is a question of time investment vs reward, and the reward for fixing the EA comments to perfection is very low.
| * HISTORY: * | ||
| * 3/3/99 GTH : Created. * | ||
| *=============================================================================================*/ | ||
| void DistLODClass::Release_Bone(int bindex) |
There was a problem hiding this comment.
This is intentional. I asked Claude to omit the description if it just repeats what the function name already says anyway.
There was a problem hiding this comment.
Its still inconsistent. DistLODDefClass::Capture_Bone still has a comment that is a function name repeat, so does DistLODClass::Set_Animation and DistLODClass::Set_Position
There was a problem hiding this comment.
// Take control of a bone.
void DistLODClass::Capture_Bone(int bindex);
// Set the animation state of this model.
void DistLODClass::Set_Animation();
// Sets the position of all lods.
void DistLODClass::Set_Position(const Vector3 &v);Yes the comments are close, but they drift a bit off the function names, so I think it is alright. They just say what EA had put there. The purpose of this change is to replace the function comment blocks with slim comments, which this change does.
| * HISTORY: * | ||
| * 3/3/99 GTH : Created. * | ||
| *=============================================================================================*/ | ||
| bool DistLODClass::Is_Bone_Captured(int bindex) const |
There was a problem hiding this comment.
This is intentional. I asked Claude to omit the description if it just repeats what the function name already says anyway.
The rules of the comment processing are writting in the Pull description. I intentionally allowed Claude to omit texts if they are redundant or obsolete information. |
|
I have asked Claude to apply another pass where it removes sentences that can be implied from the function name and signature. |
…interface The slim function comments drop every sentence that the function name, the parameter names and types or the return type already imply, such as "Cleans out the object" above reset() or "Returns true if sent OK" above a Bool function. Sentences about side effects, preconditions, ownership, units, value ranges, special return values and reasons stay. Warnings and notes follow the same rule. A few comments that were copied from another function and did not match theirs are removed as well.
d2c1872 to
bbbe465
Compare
Entirely generated with Claude Opus 5.5
AI summary
This change replaces the large Westwood comment blocks above functions with slim
//comments. It mostly affects WWVegas, max2w3d and Autorun. TheFunctions:lists in the Westwood file headers are removed too.Before:
After:
// WARNING: This function should not normally be needed during run-time.What is kept and what is dropped
// WARNING:and// NOTE:lines.// TheSuperHackers @keyword ...comments, without the date.Equivalent functions get identical comments: the Generals and Zero Hour copies, and the WW3D2 and max2w3d copies of
meshbuild.cppandaabtreebuilder.cpp.This is a comment-only change. With comments removed, every touched file is identical to its original. 2,499 blocks were converted across 654 files.
TODO