docs: add missing XML documentation to request/response model types (#1462)#454
Merged
Merged
Conversation
kirre-bylund
force-pushed
the
docs/1461-doxygen-setup
branch
from
0a8ceb9 to
0c9268c
Compare
Fixes all undocumented and empty-summary public types in the Game/Requests directory so that Doxygen emits no warnings. Files with new or completed documentation: - ProgressionsRequest.cs - LootLockerCommonRequestTypes.cs - ClassRequests.cs - AssetRequest.cs (also converts // to /// for EnumFilter properties) - LeaderboardRequest.cs (also converts // to /// for single-slash summary tags) - LeaderboardDetailsRequest.cs - PlayerRequest.cs - BalanceRequests.cs - CatalogRequests.cs - ConnectedAccountRequest.cs - CurrencyRequests.cs - EntitlementRequests.cs - FollowerRequests.cs - MetadataRequests.cs - NotificationRequests.cs - RemoteSessionRequest.cs - TriggersRequests.cs Resolves #1462
kirre-bylund
force-pushed
the
docs/1462-unity-sdk-request-response-docs
branch
from
bba4610 to
15f2806
Compare
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.
Summary
Fixes #1462 — Adds missing
/// <summary>XML documentation to all public request/response model types inRuntime/Game/Requests/so that Doxygen produces no "undocumented member" warnings.Problem
The Doxygen config uses
EXTRACT_ALL = NO/HIDE_UNDOC_MEMBERS = YES/HIDE_UNDOC_CLASSES = YES, which means any type or member without documentation is silently omitted from the generated docs. This included:///comments at all/// <summary>\n/// </summary>blocks — which Doxygen treats as undocumented//(single-slash) comments instead of///(triple-slash XML doc comments)Changes
17 files updated across two categories:
Files listed in issue #1462 (full documentation added)
ProgressionsRequest.csLootLockerCommonRequestTypes.csClassRequests.csAssetRequest.cs(also converts//→///for enum filter properties)LeaderboardRequest.cs(also fixes// <summary>single-slash tags)LeaderboardDetailsRequest.csPlayerRequest.csAdditional files found via scan (empty summaries filled in)
BalanceRequests.csCatalogRequests.csConnectedAccountRequest.csCurrencyRequests.csEntitlementRequests.csFollowerRequests.csMetadataRequests.csNotificationRequests.csRemoteSessionRequest.csTriggersRequests.csVerification
Doxygen was run locally and produces zero warnings after these changes.