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] The PR changes source comments across many code areas, but not runtime behavior. Satisfy the repository’s date rule before merging; no runtime defect was found. Findings
|
stephanmeesters
left a comment
There was a problem hiding this comment.
LGTM
Could perhsps benefit from one more filtering pass
| * HISTORY: * | ||
| * 3/29/01 1:04AM ST : Created * | ||
| *=============================================================================================*/ | ||
| // Cleans out the object. |
| * HISTORY: * | ||
| * 3/15/01 12:47PM ST : Created * | ||
| *=============================================================================================*/ | ||
| // Returns true if sent OK. |
| * 6/19/98 GTH : Created. * | ||
| * 5/23/2000 gth : Created. * | ||
| *=============================================================================================*/ | ||
| // Builds an AABTree from the contents of an AABTreeBuilderClass. |
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