Open
Conversation
Still a work in progress for documentation guidelines for the viewer.
Expanded the documentation section to better distinguish between API and implementation documentation. Added guidance on documenting legacy code, clarified where to place implementation-specific comments, and emphasized the importance of verifying claims and preserving historical context.
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR establishes comprehensive documentation standards for the Second Life Viewer project and applies them to the LLViewerObjectList class. The documentation approach emphasizes practical, engineer-focused explanations with real-world context rather than just technical descriptions.
- Creates a detailed documentation style guide focused on conversational, practical documentation
- Extensively documents LLViewerObjectList with 650+ lines of comprehensive API documentation
- Adds implementation comments explaining performance optimizations and design decisions
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| DOCUMENTATION.md | Establishes new documentation standards with style guidelines, tone requirements, and examples |
| llviewerobjectlist.h | Comprehensive documentation of all public and private APIs with practical usage examples |
| llviewerobjectlist.cpp | Implementation comments explaining algorithms, performance optimizations, and design choices |
Comments suppressed due to low confidence (2)
indra/newview/llviewerobjectlist.cpp:857
- Method name contains a typo: 'fetchPhisicsFlagsCoro' should be 'fetchPhysicsFlagsCoro'. While the comment at line 852-854 acknowledges this typo and states it's kept for compatibility, this represents a technical debt that should be addressed.
} func;
indra/newview/llviewerobjectlist.cpp:847
- Parameter name 'objectList' is inconsistent with the similar method 'reportObjectCostFailure' which uses 'objectList' in the implementation but the comment refers to it as 'obejectList' (which contains a typo).
struct f : public LLSelectedObjectFunctor
akleshchev
approved these changes
Aug 4, 2025
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
3 participants
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.
Description
Establishes some new documentation standards, and starts implementing them with LLViewerObjectList. Please focus on LLViewerObjectList's accuracy.