Release Candidate v6.5.0#133
Open
kirre-bylund wants to merge 15 commits into
Open
Conversation
- Add @addtogroup section tags inside LootLockerServerForCpp.h so each documented method section maps to its feature group (Authentication, Leaderboard, etc.) - Remove LootLockerServerForCpp.h from Doxyfile EXCLUDE so its JSDoc method comments appear in the generated docs - Fix header.html: change 'Game API' link to 'Server API' pointing to https://ref.lootlocker.com/server - Narrow @addtogroup scope in all 23 ServerAPI handler headers: close the group before the UCLASS definition so undocumented handler classes no longer appear in the feature group pages
Handler files contained undocumented structs and delegate typedefs that cluttered the feature group pages with empty, undocumented entries. Remove the section-wide @addtogroup blocks from all 24 ServerAPI handler headers. Group pages now show only the documented methods from LootLockerServerForCpp.h. Types remain accessible via the class listing and are cross-referenced from method parameter types.
…nked With EXTRACT_ALL=NO, delegate typedefs expanded from DECLARE_DELEGATE_* and response structs had no generated pages (their /* */ C-style comments are not Doxygen doc comments), so they appeared as non-clickable plain text in method parameter lists. EXTRACT_ALL=YES generates pages for all types regardless of doc comments, making FLootLockerServer*Delegate and FLootLockerServer*Response types clickable cross-references in method signatures. Group pages are unaffected: no handler files are in any @addtogroup, so groups still show only the documented LootLockerServerForCpp.h methods.
Doxygen only recognizes /// (single-line) and /** */ (block) as documentation comments. Plain // and /* */ comments are ignored, causing all UPROPERTY field descriptions and struct summaries to appear as undocumented in the generated output. Converted 23 header files: - // field comment before UPROPERTY -> /// field comment - /* block comment */ before USTRUCT/UCLASS/UPROPERTY -> /** block comment */
- mainpage.md: fix Response.success -> Response.Success, FLootLockerErrorData -> FLootLockerServerErrorData (3 occurrences) - custom-layout-fixes.css: fix comment Unity SDK -> Unreal Server SDK - Add-DelegateGroupTags.ps1: update \c:\Users\erik\Documents\projects\full-development\unreal-server-sdk\LootLockerServerSDK\Source\LootLockerServerSDK\Public and \ to ServerAPI paths and server SDK handler files - Add-EnumGroupTags.ps1: same fix - ServerAPI base and server SDK file/group mapping (5 UENUM-containing files) - Add-TypeDocComments.ps1: update \c:\Users\erik\Documents\projects\full-development\unreal-server-sdk\LootLockerServerSDK\Source\LootLockerServerSDK\Public and replace game SDK enum descriptions with server SDK enums - Move-EnumDocComments.ps1: update \c:\Users\erik\Documents\projects\full-development\unreal-server-sdk\LootLockerServerSDK\Source\LootLockerServerSDK\Public to ServerAPI path
Customers sometimes show SDK error messages directly to end users, who are unaware of LootLocker as a middleware provider. Replaced all LootLocker-branded strings in user-surfaced error messages with neutral wording. Changes: - LootLockerServerForBlueprints: Remove 'LootLockerServer' prefix from metadata parse error message Closes #1438
- Add push-to-main trigger to generate-docs.yml so latest/ auto-deploys on merge - Add deploy-pages job: deploys docs to gh-pages branch under latest/ (every push to main) and under the release tag (e.g. v2.5.0/) on release events - Maintain versions.json at the site root; sorted semver descending with latest always first - Add root index.html that meta-redirects to latest/ - Add version-picker.js: fetches versions.json and replaces the static #ll-topnav-version badge with a <select> dropdown for navigating between published versions; gracefully falls back to static badge when versions.json is unavailable (local builds) - Register version-picker.js in Doxyfile HTML_EXTRA_FILES - Load version-picker.js in header.html via <script defer> - Add <select> styles to lootlocker-theme.css matching the existing nav badge Part of lootlocker/index#1465
… dir URLs, hash preservation; fix dispatch-on-main to deploy latest/
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.
Features
IncrementScoreForMembermethod lets you add to a player's existing leaderboard score rather than overwriting it. Useful for accumulating points across multiple events without reading the current score first.Fixes
Full Changelog: v6.4.0...v6.5.0