feat(docs): Add docstrings to feat/ui-downloads - #266
Merged
Conversation
Docstrings generation was requested by @undead2146. * #265 (comment) The following files were modified: * `GenHub/GenHub.Core/Interfaces/Providers/IPublisherCatalogParser.cs` * `GenHub/GenHub.Core/Interfaces/Providers/IPublisherCatalogRefreshService.cs` * `GenHub/GenHub.Core/Interfaces/Providers/IPublisherSubscriptionStore.cs` * `GenHub/GenHub.Core/Interfaces/Providers/IVersionSelector.cs` * `GenHub/GenHub.Core/Models/Manifest/ManifestIdGenerator.cs` * `GenHub/GenHub/App.axaml.cs` * `GenHub/GenHub/Common/ViewModels/MainViewModel.cs` * `GenHub/GenHub/Common/Views/MainWindow.axaml.cs` * `GenHub/GenHub/Features/Content/Services/Catalog/GenericCatalogDiscoverer.cs` * `GenHub/GenHub/Features/Content/Services/Catalog/GenericCatalogResolver.cs` * `GenHub/GenHub/Features/Content/Services/Catalog/JsonPublisherCatalogParser.cs` * `GenHub/GenHub/Features/Content/Services/Catalog/PublisherCatalogRefreshService.cs` * `GenHub/GenHub/Features/Content/Services/Catalog/PublisherSubscriptionStore.cs` * `GenHub/GenHub/Features/Content/Services/Catalog/VersionSelector.cs` * `GenHub/GenHub/Features/Content/Services/CommunityOutpost/GenPatcherDatCatalogParser.cs` * `GenHub/GenHub/Features/Content/Services/ContentCacheService.cs` * `GenHub/GenHub/Features/Content/Services/ContentDiscoverers/AODMapsDiscoverer.cs` * `GenHub/GenHub/Features/Content/Services/ContentDiscoverers/FileSystemDiscoverer.cs` * `GenHub/GenHub/Features/Content/Services/ContentDiscoverers/ModDBDiscoverer.cs` * `GenHub/GenHub/Features/Content/Services/ContentOrchestrator.cs` * `GenHub/GenHub/Features/Content/Services/ContentResolvers/AODMapsResolver.cs` * `GenHub/GenHub/Features/Content/Services/ContentResolvers/CNCLabsMapResolver.cs` * `GenHub/GenHub/Features/Content/Services/ContentResolvers/ModDBResolver.cs` * `GenHub/GenHub/Features/Content/Services/GeneralsOnline/GeneralsOnlineDiscoverer.cs` * `GenHub/GenHub/Features/Content/Services/GeneralsOnline/GeneralsOnlineJsonCatalogParser.cs` * `GenHub/GenHub/Features/Content/Services/GitHub/GitHubReleasesDiscoverer.cs` * `GenHub/GenHub/Features/Content/Services/IContentCacheService.cs` * `GenHub/GenHub/Features/Content/Services/Parsers/ModDBPageParser.cs` * `GenHub/GenHub/Features/Content/Services/Publishers/ModDBManifestFactory.cs` * `GenHub/GenHub/Features/Content/Services/Tools/PlaywrightService.cs` * `GenHub/GenHub/Features/Content/ViewModels/Catalog/SubscriptionConfirmationViewModel.cs` * `GenHub/GenHub/Features/Downloads/Services/ContentStateService.cs` * `GenHub/GenHub/Features/Downloads/Services/IContentStateService.cs` * `GenHub/GenHub/Features/Downloads/ViewModels/ContentDetailViewModel.cs` * `GenHub/GenHub/Features/Downloads/ViewModels/ContentGridItemViewModel.cs` * `GenHub/GenHub/Features/Downloads/ViewModels/DownloadsBrowserViewModel.InstallationCheck.cs` * `GenHub/GenHub/Features/Downloads/ViewModels/DownloadsBrowserViewModel.cs` * `GenHub/GenHub/Features/Downloads/ViewModels/DownloadsViewModel.cs` * `GenHub/GenHub/Features/Downloads/ViewModels/Filters/AODMapsFilterViewModel.cs` * `GenHub/GenHub/Features/Downloads/ViewModels/Filters/CNCLabsFilterViewModel.cs` * `GenHub/GenHub/Features/Downloads/ViewModels/Filters/CommunityOutpostFilterViewModel.cs` * `GenHub/GenHub/Features/Downloads/ViewModels/Filters/FilterPanelViewModelBase.cs` * `GenHub/GenHub/Features/Downloads/ViewModels/Filters/GitHubFilterViewModel.cs` * `GenHub/GenHub/Features/Downloads/ViewModels/Filters/IFilterPanelViewModel.cs` * `GenHub/GenHub/Features/Downloads/ViewModels/Filters/ModDBFilterViewModel.cs` * `GenHub/GenHub/Features/Downloads/ViewModels/Filters/StaticPublisherFilterViewModel.cs` * `GenHub/GenHub/Features/Downloads/ViewModels/Filters/SuperHackersFilterViewModel.cs` * `GenHub/GenHub/Features/Downloads/ViewModels/ProfileSelectionViewModel.cs` * `GenHub/GenHub/Features/Downloads/Views/ContentCardView.axaml.cs` * `GenHub/GenHub/Features/Downloads/Views/ContentDetailView.axaml.cs` * `GenHub/GenHub/Features/Downloads/Views/DownloadsBrowserView.axaml.cs` * `GenHub/GenHub/Features/Downloads/Views/FilterPanelView.axaml.cs` * `GenHub/GenHub/Features/Downloads/Views/ProfileSelectionView.axaml.cs` * `GenHub/GenHub/Features/Downloads/Views/PublisherSidebarView.axaml.cs` * `GenHub/GenHub/Features/Downloads/Views/SubscriptionConfirmationDialog.axaml.cs` * `GenHub/GenHub/Features/Settings/ViewModels/SettingsViewModel.cs` * `GenHub/GenHub/Features/Settings/Views/SettingsView.axaml.cs` * `GenHub/GenHub/Infrastructure/Converters/ComparisonConverters.cs` * `GenHub/GenHub/Infrastructure/Converters/NotEqualToConverter.cs` * `GenHub/GenHub/Infrastructure/DependencyInjection/ContentPipelineModule.cs` * `GenHub/GenHub/Infrastructure/DependencyInjection/SharedViewModelModule.cs`
Open
2 tasks
Author
|
Important Review skippedThis PR was authored by the user configured for CodeRabbit reviews. By default, CodeRabbit skips reviewing PRs authored by this user. It's recommended to use a dedicated user account to post CodeRabbit review feedback. To trigger a single review, invoke the You can disable this status message by setting the Comment |
Code Review SummaryStatus: No Issues Found | Recommendation: Merge Files Reviewed (40 files)
|
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
Comment on lines
+40
to
+45
| /// <summary> | ||
| /// Verifies the publisher catalog's signature when present. | ||
| /// </summary> | ||
| /// <param name="catalogJson">The raw catalog JSON used for signature verification.</param> | ||
| /// <param name="catalog">The parsed PublisherCatalog which may include signature metadata.</param> | ||
| /// <returns>`true` if the signature is valid or verification is not required, `false` otherwise.</returns> |
There was a problem hiding this comment.
Duplicate <summary> tag. Remove the old summary (lines 35-39) and keep only the new one.
Suggested change
| /// <summary> | |
| /// Verifies the publisher catalog's signature when present. | |
| /// </summary> | |
| /// <param name="catalogJson">The raw catalog JSON used for signature verification.</param> | |
| /// <param name="catalog">The parsed PublisherCatalog which may include signature metadata.</param> | |
| /// <returns>`true` if the signature is valid or verification is not required, `false` otherwise.</returns> | |
| /// <summary> | |
| /// Verifies the publisher catalog's signature when present. | |
| /// </summary> | |
| /// <param name="catalogJson">The raw catalog JSON used for signature verification.</param> | |
| /// <param name="catalog">The parsed PublisherCatalog which may include signature metadata.</param> | |
| /// <returns>`true` if the signature is valid or verification is not required, `false` otherwise.</returns> |
Prompt To Fix With AI
This is a comment left during a code review.
Path: GenHub/GenHub.Core/Interfaces/Providers/IPublisherCatalogParser.cs
Line: 40:45
Comment:
Duplicate `<summary>` tag. Remove the old summary (lines 35-39) and keep only the new one.
```suggestion
/// <summary>
/// Verifies the publisher catalog's signature when present.
/// </summary>
/// <param name="catalogJson">The raw catalog JSON used for signature verification.</param>
/// <param name="catalog">The parsed PublisherCatalog which may include signature metadata.</param>
/// <returns>`true` if the signature is valid or verification is not required, `false` otherwise.</returns>
```
How can I resolve this? If you propose a fix, please make it concise.
Comment on lines
+98
to
+101
| /// <summary> | ||
| /// Initializes the publisher list and per-publisher filter view models. | ||
| /// </summary> | ||
| /// <returns>A task that completes after publishers and filter view models have been initialized.</returns> |
There was a problem hiding this comment.
Duplicate <summary> tag. Every method/property in this file has this duplication issue - the old summary should be replaced, not duplicated.
Suggested change
| /// <summary> | |
| /// Initializes the publisher list and per-publisher filter view models. | |
| /// </summary> | |
| /// <returns>A task that completes after publishers and filter view models have been initialized.</returns> | |
| /// <summary> | |
| /// Initializes the publisher list and per-publisher filter view models. | |
| /// </summary> | |
| /// <returns>A task that completes after publishers and filter view models have been initialized.</returns> |
Prompt To Fix With AI
This is a comment left during a code review.
Path: GenHub/GenHub/Features/Downloads/ViewModels/DownloadsBrowserViewModel.cs
Line: 98:101
Comment:
Duplicate `<summary>` tag. Every method/property in this file has this duplication issue - the old summary should be replaced, not duplicated.
```suggestion
/// <summary>
/// Initializes the publisher list and per-publisher filter view models.
/// </summary>
/// <returns>A task that completes after publishers and filter view models have been initialized.</returns>
```
How can I resolve this? If you propose a fix, please make it concise.
Comment on lines
+25
to
+30
| /// <summary> | ||
| /// Determines the ModDB page type by inspecting the document DOM and URL patterns. | ||
| /// </summary> | ||
| /// <param name="url">The page URL used to identify list-like paths (for example, "/addons" or "/images").</param> | ||
| /// <param name="document">The parsed HTML document used to detect DOM-specific markers.</param> | ||
| /// <returns>One of PageType.FileDetail, PageType.List, PageType.Summary, or PageType.Detail indicating the page category.</returns> |
There was a problem hiding this comment.
Duplicate <summary> tag. This file has duplicate summaries on every method - old summaries should be removed, not kept alongside new ones.
Suggested change
| /// <summary> | |
| /// Determines the ModDB page type by inspecting the document DOM and URL patterns. | |
| /// </summary> | |
| /// <param name="url">The page URL used to identify list-like paths (for example, "/addons" or "/images").</param> | |
| /// <param name="document">The parsed HTML document used to detect DOM-specific markers.</param> | |
| /// <returns>One of PageType.FileDetail, PageType.List, PageType.Summary, or PageType.Detail indicating the page category.</returns> | |
| /// <summary> | |
| /// Determines the ModDB page type by inspecting the document DOM and URL patterns. | |
| /// </summary> | |
| /// <param name="url">The page URL used to identify list-like paths (for example, "/addons" or "/images").</param> | |
| /// <param name="document">The parsed HTML document used to detect DOM-specific markers.</param> | |
| /// <returns>One of PageType.FileDetail, PageType.List, PageType.Summary, or PageType.Detail indicating the page category.</returns> |
Prompt To Fix With AI
This is a comment left during a code review.
Path: GenHub/GenHub/Features/Content/Services/Parsers/ModDBPageParser.cs
Line: 25:30
Comment:
Duplicate `<summary>` tag. This file has duplicate summaries on every method - old summaries should be removed, not kept alongside new ones.
```suggestion
/// <summary>
/// Determines the ModDB page type by inspecting the document DOM and URL patterns.
/// </summary>
/// <param name="url">The page URL used to identify list-like paths (for example, "/addons" or "/images").</param>
/// <param name="document">The parsed HTML document used to detect DOM-specific markers.</param>
/// <returns>One of PageType.FileDetail, PageType.List, PageType.Summary, or PageType.Detail indicating the page category.</returns>
```
How can I resolve this? If you propose a fix, please make it concise.
Comment on lines
+54
to
+61
| /// <summary> | ||
| /// Initializes the application's main window and lifecycle when running as a classic desktop application. | ||
| /// </summary> | ||
| /// <remarks> | ||
| /// When the application lifetime is a classic desktop lifetime, this method creates the main window with its | ||
| /// view model, applies persisted window settings, assigns the window as the application's main window, | ||
| /// registers shutdown handling, subscribes to single-instance IPC commands, and begins processing startup arguments. | ||
| /// </remarks> |
There was a problem hiding this comment.
Duplicate <summary> tag. Remove lines 51-53 to keep only the new summary.
Suggested change
| /// <summary> | |
| /// Initializes the application's main window and lifecycle when running as a classic desktop application. | |
| /// </summary> | |
| /// <remarks> | |
| /// When the application lifetime is a classic desktop lifetime, this method creates the main window with its | |
| /// view model, applies persisted window settings, assigns the window as the application's main window, | |
| /// registers shutdown handling, subscribes to single-instance IPC commands, and begins processing startup arguments. | |
| /// </remarks> | |
| /// <summary> | |
| /// Initializes the application's main window and lifecycle when running as a classic desktop application. | |
| /// </summary> | |
| /// <remarks> | |
| /// When the application lifetime is a classic desktop lifetime, this method creates the main window with its | |
| /// view model, applies persisted window settings, assigns the window as the application's main window, | |
| /// registers shutdown handling, subscribes to single-instance IPC commands, and begins processing startup arguments. | |
| /// </remarks> |
Prompt To Fix With AI
This is a comment left during a code review.
Path: GenHub/GenHub/App.axaml.cs
Line: 54:61
Comment:
Duplicate `<summary>` tag. Remove lines 51-53 to keep only the new summary.
```suggestion
/// <summary>
/// Initializes the application's main window and lifecycle when running as a classic desktop application.
/// </summary>
/// <remarks>
/// When the application lifetime is a classic desktop lifetime, this method creates the main window with its
/// view model, applies persisted window settings, assigns the window as the application's main window,
/// registers shutdown handling, subscribes to single-instance IPC commands, and begins processing startup arguments.
/// </remarks>
```
How can I resolve this? If you propose a fix, please make it concise.
undead2146
changed the title
feat/ui-downloadsfeat/ui-downloads
…r.cs Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
…r.cs Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Comment on lines
24
to
33
| /// <summary> | ||
| /// Validates that a catalog conforms to the expected schema version. | ||
| /// </summary> | ||
| /// <param name="catalog">The catalog to validate.</param> | ||
| /// <returns>Validation result with any errors.</returns> | ||
| /// <summary> | ||
| /// Validates that a PublisherCatalog conforms to the expected schema version and structure. | ||
| /// </summary> | ||
| /// <param name="catalog">The parsed publisher catalog to validate.</param> | ||
| /// <returns>`true` if the catalog is valid; `false` otherwise. The OperationResult contains validation errors when present.</returns> | ||
| OperationResult<bool> ValidateCatalog(PublisherCatalog catalog); |
There was a problem hiding this comment.
Duplicate <summary> tag - remove lines 24-27.
Suggested change
| /// <summary> | |
| /// Validates that a catalog conforms to the expected schema version. | |
| /// </summary> | |
| /// <param name="catalog">The catalog to validate.</param> | |
| /// <returns>Validation result with any errors.</returns> | |
| /// <summary> | |
| /// Validates that a PublisherCatalog conforms to the expected schema version and structure. | |
| /// </summary> | |
| /// <param name="catalog">The parsed publisher catalog to validate.</param> | |
| /// <returns>`true` if the catalog is valid; `false` otherwise. The OperationResult contains validation errors when present.</returns> | |
| OperationResult<bool> ValidateCatalog(PublisherCatalog catalog); | |
| /// <summary> | |
| /// Validates that a PublisherCatalog conforms to the expected schema version and structure. | |
| /// </summary> | |
| /// <param name="catalog">The parsed publisher catalog to validate.</param> | |
| /// <returns>`true` if the catalog is valid; `false` otherwise. The OperationResult contains validation errors when present.</returns> | |
| OperationResult<bool> ValidateCatalog(PublisherCatalog catalog); |
Prompt To Fix With AI
This is a comment left during a code review.
Path: GenHub/GenHub.Core/Interfaces/Providers/IPublisherCatalogParser.cs
Line: 24:33
Comment:
Duplicate `<summary>` tag - remove lines 24-27.
```suggestion
/// <summary>
/// Validates that a PublisherCatalog conforms to the expected schema version and structure.
/// </summary>
/// <param name="catalog">The parsed publisher catalog to validate.</param>
/// <returns>`true` if the catalog is valid; `false` otherwise. The OperationResult contains validation errors when present.</returns>
OperationResult<bool> ValidateCatalog(PublisherCatalog catalog);
```
How can I resolve this? If you propose a fix, please make it concise.
Comment on lines
35
to
46
| /// <summary> | ||
| /// Verifies the catalog signature if present. | ||
| /// </summary> | ||
| /// <param name="catalogJson">The raw JSON content.</param> | ||
| /// <param name="catalog">The parsed catalog with signature field.</param> | ||
| /// <returns>True if signature is valid or not required.</returns> | ||
| /// <summary> | ||
| /// Verifies the publisher catalog's signature when present. | ||
| /// </summary> | ||
| /// <param name="catalogJson">The raw catalog JSON used for signature verification.</param> | ||
| /// <param name="catalog">The parsed PublisherCatalog which may include signature metadata.</param> | ||
| /// <returns>`true` if the signature is valid or verification is not required, `false` otherwise.</returns> | ||
| bool VerifySignature(string catalogJson, PublisherCatalog catalog); |
There was a problem hiding this comment.
Duplicate <summary> tag and incorrect indentation - remove lines 35-39.
Suggested change
| /// <summary> | |
| /// Verifies the catalog signature if present. | |
| /// </summary> | |
| /// <param name="catalogJson">The raw JSON content.</param> | |
| /// <param name="catalog">The parsed catalog with signature field.</param> | |
| /// <returns>True if signature is valid or not required.</returns> | |
| /// <summary> | |
| /// Verifies the publisher catalog's signature when present. | |
| /// </summary> | |
| /// <param name="catalogJson">The raw catalog JSON used for signature verification.</param> | |
| /// <param name="catalog">The parsed PublisherCatalog which may include signature metadata.</param> | |
| /// <returns>`true` if the signature is valid or verification is not required, `false` otherwise.</returns> | |
| bool VerifySignature(string catalogJson, PublisherCatalog catalog); | |
| /// <summary> | |
| /// Verifies the publisher catalog's signature when present. | |
| /// </summary> | |
| /// <param name="catalogJson">The raw catalog JSON used for signature verification.</param> | |
| /// <param name="catalog">The parsed PublisherCatalog which may include signature metadata.</param> | |
| /// <returns>`true` if the signature is valid or verification is not required, `false` otherwise.</returns> | |
| bool VerifySignature(string catalogJson, PublisherCatalog catalog); | |
| } |
Prompt To Fix With AI
This is a comment left during a code review.
Path: GenHub/GenHub.Core/Interfaces/Providers/IPublisherCatalogParser.cs
Line: 35:46
Comment:
Duplicate `<summary>` tag and incorrect indentation - remove lines 35-39.
```suggestion
/// <summary>
/// Verifies the publisher catalog's signature when present.
/// </summary>
/// <param name="catalogJson">The raw catalog JSON used for signature verification.</param>
/// <param name="catalog">The parsed PublisherCatalog which may include signature metadata.</param>
/// <returns>`true` if the signature is valid or verification is not required, `false` otherwise.</returns>
bool VerifySignature(string catalogJson, PublisherCatalog catalog);
}
```
How can I resolve this? If you propose a fix, please make it concise.
Comment on lines
51
to
62
| /// <summary> | ||
| /// Called when the Avalonia framework initialization is completed. | ||
| /// Sets up the main window and applies window settings. | ||
| /// <summary> | ||
| /// Initializes the application's main window and lifecycle when running as a classic desktop application. | ||
| /// </summary> | ||
| /// <remarks> | ||
| /// When the application lifetime is a classic desktop lifetime, this method creates the main window with its | ||
| /// view model, applies persisted window settings, assigns the window as the application's main window, | ||
| /// registers shutdown handling, subscribes to single-instance IPC commands, and begins processing startup arguments. | ||
| /// </remarks> | ||
| public override void OnFrameworkInitializationCompleted() |
There was a problem hiding this comment.
Duplicate <summary> tag - remove lines 51-53.
Suggested change
| /// <summary> | |
| /// Called when the Avalonia framework initialization is completed. | |
| /// Sets up the main window and applies window settings. | |
| /// <summary> | |
| /// Initializes the application's main window and lifecycle when running as a classic desktop application. | |
| /// </summary> | |
| /// <remarks> | |
| /// When the application lifetime is a classic desktop lifetime, this method creates the main window with its | |
| /// view model, applies persisted window settings, assigns the window as the application's main window, | |
| /// registers shutdown handling, subscribes to single-instance IPC commands, and begins processing startup arguments. | |
| /// </remarks> | |
| public override void OnFrameworkInitializationCompleted() | |
| /// <summary> | |
| /// Initializes the application's main window and lifecycle when running as a classic desktop application. | |
| /// </summary> | |
| /// <remarks> | |
| /// When the application lifetime is a classic desktop lifetime, this method creates the main window with its | |
| /// view model, applies persisted window settings, assigns the window as the application's main window, | |
| /// registers shutdown handling, subscribes to single-instance IPC commands, and begins processing startup arguments. | |
| /// </remarks> | |
| public override void OnFrameworkInitializationCompleted() |
Prompt To Fix With AI
This is a comment left during a code review.
Path: GenHub/GenHub/App.axaml.cs
Line: 51:62
Comment:
Duplicate `<summary>` tag - remove lines 51-53.
```suggestion
/// <summary>
/// Initializes the application's main window and lifecycle when running as a classic desktop application.
/// </summary>
/// <remarks>
/// When the application lifetime is a classic desktop lifetime, this method creates the main window with its
/// view model, applies persisted window settings, assigns the window as the application's main window,
/// registers shutdown handling, subscribes to single-instance IPC commands, and begins processing startup arguments.
/// </remarks>
public override void OnFrameworkInitializationCompleted()
```
How can I resolve this? If you propose a fix, please make it concise.
Comment on lines
95
to
102
| /// <summary> | ||
| /// Performs asynchronous initialization. | ||
| /// </summary> | ||
| /// <returns>A task representing the asynchronous operation.</returns> | ||
| /// <summary> | ||
| /// Initializes the publisher list and per-publisher filter view models. | ||
| /// </summary> | ||
| /// <returns>A task that completes after publishers and filter view models have been initialized.</returns> | ||
| public Task InitializeAsync() |
There was a problem hiding this comment.
Duplicate <summary> tag - remove lines 95-97.
Prompt To Fix With AI
This is a comment left during a code review.
Path: GenHub/GenHub/Features/Downloads/ViewModels/DownloadsBrowserViewModel.cs
Line: 95:102
Comment:
Duplicate `<summary>` tag - remove lines 95-97.
How can I resolve this? If you propose a fix, please make it concise.
Comment on lines
109
to
116
| /// <summary> | ||
| /// Called when the Downloads tab is activated. | ||
| /// </summary> | ||
| /// <returns>A task representing the asynchronous operation.</returns> | ||
| /// <summary> | ||
| /// Ensures content is loaded when the tab becomes active by triggering a refresh if no items are present and loading is not already in progress. | ||
| /// </summary> | ||
| /// <returns>A task that completes when the content refresh (if performed) finishes.</returns> | ||
| public async Task OnTabActivatedAsync() |
There was a problem hiding this comment.
Duplicate <summary> tag - remove lines 109-111.
Prompt To Fix With AI
This is a comment left during a code review.
Path: GenHub/GenHub/Features/Downloads/ViewModels/DownloadsBrowserViewModel.cs
Line: 109:116
Comment:
Duplicate `<summary>` tag - remove lines 109-111.
How can I resolve this? If you propose a fix, please make it concise.
Comment on lines
23
to
31
| /// <summary> | ||
| /// Detects the page type based on URL patterns and DOM structure. | ||
| /// <summary> | ||
| /// Determines the ModDB page type by inspecting the document DOM and URL patterns. | ||
| /// </summary> | ||
| /// <param name="url">The page URL used to identify list-like paths (for example, "/addons" or "/images").</param> | ||
| /// <param name="document">The parsed HTML document used to detect DOM-specific markers.</param> | ||
| /// <returns>One of PageType.FileDetail, PageType.List, PageType.Summary, or PageType.Detail indicating the page category.</returns> | ||
| private static PageType DetectPageType(string url, IDocument document) |
There was a problem hiding this comment.
Duplicate <summary> tag - remove line 23-25.
Prompt To Fix With AI
This is a comment left during a code review.
Path: GenHub/GenHub/Features/Content/Services/Parsers/ModDBPageParser.cs
Line: 23:31
Comment:
Duplicate `<summary>` tag - remove line 23-25.
How can I resolve this? If you propose a fix, please make it concise.
Additional Comments (1)
Prompt To Fix With AIThis is a comment left during a code review.
Path: GenHub/GenHub.Core/Interfaces/Providers/IPublisherCatalogParser.cs
Line: 11:22
Comment:
Duplicate `<summary>` tags break XML docs. Remove old summary (lines 11-15) and keep only new one.
How can I resolve this? If you propose a fix, please make it concise. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Docstrings generation was requested by @undead2146.
The following files were modified:
GenHub/GenHub.Core/Interfaces/Providers/IPublisherCatalogParser.csGenHub/GenHub.Core/Interfaces/Providers/IPublisherCatalogRefreshService.csGenHub/GenHub.Core/Interfaces/Providers/IPublisherSubscriptionStore.csGenHub/GenHub.Core/Interfaces/Providers/IVersionSelector.csGenHub/GenHub.Core/Models/Manifest/ManifestIdGenerator.csGenHub/GenHub/App.axaml.csGenHub/GenHub/Common/ViewModels/MainViewModel.csGenHub/GenHub/Common/Views/MainWindow.axaml.csGenHub/GenHub/Features/Content/Services/Catalog/GenericCatalogDiscoverer.csGenHub/GenHub/Features/Content/Services/Catalog/GenericCatalogResolver.csGenHub/GenHub/Features/Content/Services/Catalog/JsonPublisherCatalogParser.csGenHub/GenHub/Features/Content/Services/Catalog/PublisherCatalogRefreshService.csGenHub/GenHub/Features/Content/Services/Catalog/PublisherSubscriptionStore.csGenHub/GenHub/Features/Content/Services/Catalog/VersionSelector.csGenHub/GenHub/Features/Content/Services/CommunityOutpost/GenPatcherDatCatalogParser.csGenHub/GenHub/Features/Content/Services/ContentCacheService.csGenHub/GenHub/Features/Content/Services/ContentDiscoverers/AODMapsDiscoverer.csGenHub/GenHub/Features/Content/Services/ContentDiscoverers/FileSystemDiscoverer.csGenHub/GenHub/Features/Content/Services/ContentDiscoverers/ModDBDiscoverer.csGenHub/GenHub/Features/Content/Services/ContentOrchestrator.csGenHub/GenHub/Features/Content/Services/ContentResolvers/AODMapsResolver.csGenHub/GenHub/Features/Content/Services/ContentResolvers/CNCLabsMapResolver.csGenHub/GenHub/Features/Content/Services/ContentResolvers/ModDBResolver.csGenHub/GenHub/Features/Content/Services/GeneralsOnline/GeneralsOnlineDiscoverer.csGenHub/GenHub/Features/Content/Services/GeneralsOnline/GeneralsOnlineJsonCatalogParser.csGenHub/GenHub/Features/Content/Services/GitHub/GitHubReleasesDiscoverer.csGenHub/GenHub/Features/Content/Services/IContentCacheService.csGenHub/GenHub/Features/Content/Services/Parsers/ModDBPageParser.csGenHub/GenHub/Features/Content/Services/Publishers/ModDBManifestFactory.csGenHub/GenHub/Features/Content/Services/Tools/PlaywrightService.csGenHub/GenHub/Features/Content/ViewModels/Catalog/SubscriptionConfirmationViewModel.csGenHub/GenHub/Features/Downloads/Services/ContentStateService.csGenHub/GenHub/Features/Downloads/Services/IContentStateService.csGenHub/GenHub/Features/Downloads/ViewModels/ContentDetailViewModel.csGenHub/GenHub/Features/Downloads/ViewModels/ContentGridItemViewModel.csGenHub/GenHub/Features/Downloads/ViewModels/DownloadsBrowserViewModel.InstallationCheck.csGenHub/GenHub/Features/Downloads/ViewModels/DownloadsBrowserViewModel.csGenHub/GenHub/Features/Downloads/ViewModels/DownloadsViewModel.csGenHub/GenHub/Features/Downloads/ViewModels/Filters/AODMapsFilterViewModel.csGenHub/GenHub/Features/Downloads/ViewModels/Filters/CNCLabsFilterViewModel.csGenHub/GenHub/Features/Downloads/ViewModels/Filters/CommunityOutpostFilterViewModel.csGenHub/GenHub/Features/Downloads/ViewModels/Filters/FilterPanelViewModelBase.csGenHub/GenHub/Features/Downloads/ViewModels/Filters/GitHubFilterViewModel.csGenHub/GenHub/Features/Downloads/ViewModels/Filters/IFilterPanelViewModel.csGenHub/GenHub/Features/Downloads/ViewModels/Filters/ModDBFilterViewModel.csGenHub/GenHub/Features/Downloads/ViewModels/Filters/StaticPublisherFilterViewModel.csGenHub/GenHub/Features/Downloads/ViewModels/Filters/SuperHackersFilterViewModel.csGenHub/GenHub/Features/Downloads/ViewModels/ProfileSelectionViewModel.csGenHub/GenHub/Features/Downloads/Views/ContentCardView.axaml.csGenHub/GenHub/Features/Downloads/Views/ContentDetailView.axaml.csGenHub/GenHub/Features/Downloads/Views/DownloadsBrowserView.axaml.csGenHub/GenHub/Features/Downloads/Views/FilterPanelView.axaml.csGenHub/GenHub/Features/Downloads/Views/ProfileSelectionView.axaml.csGenHub/GenHub/Features/Downloads/Views/PublisherSidebarView.axaml.csGenHub/GenHub/Features/Downloads/Views/SubscriptionConfirmationDialog.axaml.csGenHub/GenHub/Features/Settings/ViewModels/SettingsViewModel.csGenHub/GenHub/Features/Settings/Views/SettingsView.axaml.csGenHub/GenHub/Infrastructure/Converters/ComparisonConverters.csGenHub/GenHub/Infrastructure/Converters/NotEqualToConverter.csGenHub/GenHub/Infrastructure/DependencyInjection/ContentPipelineModule.csGenHub/GenHub/Infrastructure/DependencyInjection/SharedViewModelModule.csThese files were kept as they were
GenHub/GenHub/Features/GameProfiles/Infrastructure/GameProcessManager.csThese files were ignored
GenHub/GenHub.Tests/GenHub.Tests.Core/Common/Services/ConfigurationProviderServiceTests.csGenHub/GenHub.Tests/GenHub.Tests.Core/Features/Content/CNCLabsMapDiscovererTests.csGenHub/GenHub.Tests/GenHub.Tests.Core/Features/Content/GitHubResolverTests.csGenHub/GenHub.Tests/GenHub.Tests.Core/Features/GameClients/GameClientManifestIntegrationTests.csGenHub/GenHub.Tests/GenHub.Tests.Core/Features/GameProfiles/ViewModels/MainViewModelTests.csGenHub/GenHub.Tests/GenHub.Tests.Core/Features/GameProfiles/ViewModels/SettingsViewModelTests.csGenHub/GenHub.Tests/GenHub.Tests.Core/Features/Manifest/ContentManifestBuilderTests.csGenHub/GenHub.Tests/GenHub.Tests.Core/Features/Manifest/ManifestGenerationServiceTests.csGenHub/GenHub.Tests/GenHub.Tests.Core/Infrastructure/DependencyInjection/SharedViewModelModuleTests.csThese file types are not supported
GenHub/GenHub.Core/GenHub.Core.csprojGenHub/GenHub/Common/Views/MainView.axamlGenHub/GenHub/Common/Views/MainWindow.axamlGenHub/GenHub/Features/Downloads/Views/ContentCardView.axamlGenHub/GenHub/Features/Downloads/Views/ContentDetailView.axamlGenHub/GenHub/Features/Downloads/Views/DownloadsBrowserView.axamlGenHub/GenHub/Features/Downloads/Views/DownloadsView.axamlGenHub/GenHub/Features/Downloads/Views/FilterPanelView.axamlGenHub/GenHub/Features/Downloads/Views/ProfileSelectionView.axamlGenHub/GenHub/Features/Downloads/Views/PublisherSidebarView.axamlGenHub/GenHub/Features/Downloads/Views/SubscriptionConfirmationDialog.axamlGenHub/GenHub/Features/Settings/Views/SettingsView.axamlcoding-style.mddocs/FlowCharts/Discovery-Flow.mddocs/FlowCharts/Downloads-Flow.mddocs/FlowCharts/index.mddocs/dev/constants.mddocs/dev/contribution-guidelines.mddocs/dev/creator-publishing-roadmap.mddocs/dev/manifest-id-system.mddocs/dev/models.mddocs/features/content/content-dependencies.mddocs/features/content/content-pipeline.mddocs/features/content/creator-publishing.mddocs/features/content/index.mddocs/features/content/provider-configuration.mddocs/features/content/universal-parser.mddocs/features/downloads.mdℹ️ Note
Greptile Overview
Greptile Summary
This PR adds XML documentation comments (docstrings) to 61 C# files across the
feat/ui-downloadsbranch. However, the automated generation created duplicate<summary>tags on virtually every method and interface member, resulting in malformed XML documentation that will cause compilation errors or warnings when XML documentation generation is enabled.Critical Issues:
<summary>elements - the old summary was kept and a new one was added instead of replacing it<summary>element per memberImpact:
Required Action:
All duplicate
<summary>tags must be removed - keep only the new, more detailed summaries and delete the original ones. This is a systematic issue affecting the entire PR and must be fixed before merge.Confidence Score: 0/5
<summary>tags appear on nearly every documented member across all 61 files, creating invalid XML that will cause build warnings/errors. This directly violates the repository rule requiring all compiler and linter warnings to be resolved before merging. The issue is systematic and affects the entire PR.<summary>tags. Priority files include interface definitions (IPublisherCatalogParser.cs, IPublisherCatalogRefreshService.cs, IVersionSelector.cs) and large view models (DownloadsBrowserViewModel.cs, ContentDetailViewModel.cs, ModDBPageParser.cs).Important Files Changed
<summary>tags on all three methods - breaks XML documentation compilation<summary>tags on both methods - invalid XML documentation<summary>tags on all three methods - malformed XML docs<summary>tag onOnFrameworkInitializationCompletedmethod - invalid XML<summary>tags on nearly all methods throughout the file<summary>tags - every method has this duplication issue<summary>tags across all documented members<summary>tags on multiple methods<summary>tags on interface methodsSequence Diagram
sequenceDiagram participant Bot as coderabbitai[bot] participant Files as C# Source Files participant DocGen as Documentation Generator participant XML as XML Doc Output participant Compiler as C# Compiler Bot->>Files: Add docstrings to 61 files Note over Bot,Files: Automated generation process Files->>Files: Keep existing <summary> tags Files->>Files: Add new <summary> tags Note over Files: Result: Duplicate <summary> elements Files->>DocGen: Generate XML documentation DocGen->>XML: Parse XML comments XML-->>DocGen: ❌ Invalid XML structure Note over XML: Multiple <summary> per member Files->>Compiler: Build with XML doc generation Compiler->>Compiler: Validate XML comments Compiler-->>Files: ⚠️ Warnings/Errors Note over Compiler: XML documentation malformed Note over Bot,Compiler: Required: Remove old summaries,<br/>keep only new detailed onesContext used:
dashboard- What: All compiler warnings and linter warnings across the entire codebase must be resolved before m... (source)