Skip to content

📝 Scribe: Add XML documentation for RemoteAgents#108

Open
nt153133 wants to merge 1 commit into
mainfrom
scribe/add-xml-docs-agents-9991041703342771981
Open

📝 Scribe: Add XML documentation for RemoteAgents#108
nt153133 wants to merge 1 commit into
mainfrom
scribe/add-xml-docs-agents-9991041703342771981

Conversation

@nt153133

Copy link
Copy Markdown
Owner

📝 Scribe: Add XML documentation for RemoteAgents

💡 What

This pull request adds high-quality, professional-grade triple-slash (///) XML documentation to several previously undocumented classes and structures in the RemoteAgents namespace:

  • AgentDeepDungeonStatus (and IdRaw, Instance)
  • AgentGoldSaucerInfo
  • AgentHousing
  • AgentHousingSelectBlock (and WardNumber, ReadPlots)
  • AgentMinionNoteBook (and MinionListAddress, GetCurrentMinions, GetMinionName, as well as MinionStruct and its fields)
  • AgentWorldTravelSelect (and CurrentWorld, ChoicesPointer, HomeWorld, NumberOfWorlds, Choices, as well as WorldChoice and its properties under various compile options)

🎯 Why

These remote agents interact directly with the game memory and UI state, making type safety, documentation, and clarity paramount. This documentation explains:

  • Regional compile logic discrepancies (e.g. why we skip HomeWorld or have different MaxSkip/MaxCountOffset values on standard vs. Tencent clients in AgentWorldTravelSelect).
  • Zero-based vs. one-based indices (e.g. zero-based ward index selection for AgentHousingSelectBlock).
  • Domain-specific systems like Palace of the Dead, Heaven-on-High, and Eureka Orthos.

🔬 Examples

    /// <summary>
    /// Remote agent for the World Travel selection interface.
    /// Manages cross-world visit options and retrieves available target worlds.
    /// </summary>
    /// <remarks>
    /// In other regions, a skip logic (<c>MaxSkip = 1</c>) is used to filter out the player's home world from the target choices,
    /// while for the Tencent version (RB_TC), no home world skipping is applied (<c>MaxSkip = 0</c>).
    /// </remarks>

PR created automatically by Jules for task 9991041703342771981 started by @nt153133

…SaucerInfo, AgentHousing, AgentHousingSelectBlock, AgentMinionNoteBook, and AgentWorldTravelSelect

WHAT: Add comprehensive XML documentation comments to undocumented remote agents (AgentDeepDungeonStatus, AgentGoldSaucerInfo, AgentHousing, AgentHousingSelectBlock, AgentMinionNoteBook, AgentWorldTravelSelect) and their nested or associated structs.
WHY: Elevate clarity and codebase maintainability around FFXIV remote agents, detailing domain concepts like ward selection zero-based indices, world skipping travel selection logic on non-TC clients, and minion notebook arrays.
EXAMPLES:
- Detailed <summary>, <param>, and <remarks> tags on classes, constructors, fields, properties, and methods.
- Documented regional TC compilation adjustments.

Co-authored-by: nt153133 <[email protected]>
@google-labs-jules

Copy link
Copy Markdown
Contributor

👋 Jules, reporting for duty! I'm here to lend a hand with this pull request.

When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down.

I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job!

For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.


For security, I will only act on instructions from the user who triggered this task.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant