From 284d0ea1082305bbea734c839552b4e0de14552c Mon Sep 17 00:00:00 2001 From: Matt Nadareski Date: Sun, 27 Oct 2024 00:01:22 -0400 Subject: [PATCH] Clear out old info from the coding guide --- Coding Guide.md | 41 ++++++++++++----------------------------- 1 file changed, 12 insertions(+), 29 deletions(-) diff --git a/Coding Guide.md b/Coding Guide.md index f0ea1235..f065bf46 100644 --- a/Coding Guide.md +++ b/Coding Guide.md @@ -318,22 +318,13 @@ This section contains information on project and class organization principles t | Project | Description | | --- | --- | | `BinaryObjectScanner` | One file per class. See below for details on subdirectories. | -| `BinaryObjectScanner/External` | One directory per external project. | +| `BinaryObjectScanner/_EXTERNAL` | One directory per external project. | | `BinaryObjectScanner/FileType` | One file per file type. | -| `BinaryObjectScanner/Tools` | Two files - one for extension methods and one for utilities. | -| `BinaryObjectScanner.ASN1` | Flat directory structure. | -| `BinaryObjectScanner.Builders` | One file per executable type. | -| `BinaryObjectScanner.Compression` | One directory per compression type. | -| `BinaryObjectScanner.FileType` | One file per file type. | -| `BinaryObjectScanner.GameEngine` | At least one file per game engine. Partial classes allowed. | -| `BinaryObjectScanner.Interfaces` | One file per interface. | -| `BinaryObjectScanner.Matching` | Flat directory structure. Include interfaces and base classes. | -| `BinaryObjectScanner.Models` | One directory per executable type. One file per object model. | -| `BinaryObjectScanner.Packer` | At least one file per packer type. Partial classes allowed. | -| `BinaryObjectScanner.Protection` | At least one file per protection type. Partial classes allowed. | -| `BinaryObjectScanner.Utilities` | Flat directory structure. | -| `BinaryObjectScanner.Wrappers` | One file per executable type. Common functionality goes in `WrapperBase.cs`. | -| `psxt001z` | Flat directory structure. | +| `BinaryObjectScanner/GameEngine` | At least one file per game engine. Partial classes allowed. | +| `BinaryObjectScanner/Interfaces` | One file per interface. | +| `BinaryObjectScanner/Packer` | At least one file per packer type. Partial classes allowed. | +| `BinaryObjectScanner/Protection` | At least one file per protection type. Partial classes allowed. | +| `BinaryObjectScanner/Utilities` | Flat directory structure. | | `Test` | All functionality lives in `Program.cs`. | If the project or directory you are looking for is not included in the above, please consider it to be outside the context of this document. @@ -345,20 +336,12 @@ This section contains information on in-code organization principles that depend | Project | Description | | --- | --- | | `BinaryObjectScanner` | Varies from file to file. | -| `BinaryObjectScanner/Tools` | Methods grouped by function. Regions ordered alphabetically. | -| `BinaryObjectScanner.ASN1` | Partial classes suggested for different implmentations. | -| `BinaryObjectScanner.Builders` | Two copies of each non-generic method: one for byte arrays and one for Streams. | -| `BinaryObjectScanner.Compression` | Varies from file to file. | -| `BinaryObjectScanner.FileType` | `IDetectable` implementations, `IExtractable` implementations, helper methods. | -| `BinaryObjectScanner.GameEngine` | `IContentCheck` implementations, `ILinearExecutableCheck` implementations, `INewExecutableCheck` implementations, `IPortableExecutableCheck` implementations, `IPathCheck` implementations, `IExtractable` implementations, helper methods. | -| `BinaryObjectScanner.Interfaces` | Methods ordered alphabetically. | -| `BinaryObjectScanner.Matching` | Varies from file to file. | -| `BinaryObjectScanner.Models` | No methods at all, just properties. | -| `BinaryObjectScanner.Packer` | `IContentCheck` implementations, `ILinearExecutableCheck` implementations, `INewExecutableCheck` implementations, `IPortableExecutableCheck` implementations, `IPathCheck` implementations, `IExtractable` implementations, helper methods. | -| `BinaryObjectScanner.Protection` | `IContentCheck` implementations, `ILinearExecutableCheck` implementations, `INewExecutableCheck` implementations, `IPortableExecutableCheck` implementations, `IPathCheck` implementations, `IExtractable` implementations, helper methods. | -| `BinaryObjectScanner.Utilities` | Varies from file to file. | -| `BinaryObjectScanner.Wrappers` | Follow region and method grouping from existing wrappers. | -| `psxt001z` | Varies from file to file. | +| `BinaryObjectScanner/FileType` | `IDetectable` implementations, `IExtractable` implementations, helper methods. | +| `BinaryObjectScanner/GameEngine` | `IContentCheck` implementations, `ILinearExecutableCheck` implementations, `INewExecutableCheck` implementations, `IPortableExecutableCheck` implementations, `IPathCheck` implementations, `IExtractable` implementations, helper methods. | +| `BinaryObjectScanner/Interfaces` | Methods ordered alphabetically. | +| `BinaryObjectScanner/Packer` | `IContentCheck` implementations, `ILinearExecutableCheck` implementations, `INewExecutableCheck` implementations, `IPortableExecutableCheck` implementations, `IPathCheck` implementations, `IExtractable` implementations, helper methods. | +| `BinaryObjectScanner/Protection` | `IContentCheck` implementations, `ILinearExecutableCheck` implementations, `INewExecutableCheck` implementations, `IPortableExecutableCheck` implementations, `IPathCheck` implementations, `IExtractable` implementations, helper methods. | +| `BinaryObjectScanner/Utilities` | Varies from file to file. | | `Test` | New functionality should be added as a combination of a flag with a long and a short form, a new line in the help text, and a new method (if necessary). | If the project or directory you are looking for is not included in the above, please consider it to be outside the context of this document.