📝 Scribe: Add XML documentation for RemoteAgents#108
Conversation
…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]>
|
👋 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 New to Jules? Learn more at jules.google/docs. For security, I will only act on instructions from the user who triggered this task. |
📝 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 theRemoteAgentsnamespace:AgentDeepDungeonStatus(andIdRaw,Instance)AgentGoldSaucerInfoAgentHousingAgentHousingSelectBlock(andWardNumber,ReadPlots)AgentMinionNoteBook(andMinionListAddress,GetCurrentMinions,GetMinionName, as well asMinionStructand its fields)AgentWorldTravelSelect(andCurrentWorld,ChoicesPointer,HomeWorld,NumberOfWorlds,Choices, as well asWorldChoiceand 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:
HomeWorldor have differentMaxSkip/MaxCountOffsetvalues on standard vs. Tencent clients inAgentWorldTravelSelect).AgentHousingSelectBlock).🔬 Examples
PR created automatically by Jules for task 9991041703342771981 started by @nt153133