[docs] Add missing package docs #5108
Merged
Conversation
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
vincentpierre
approved these changes
Mar 12, 2021
| @@ -12,7 +12,9 @@ public class SimpleMultiAgentGroup : IMultiAgentGroup, IDisposable | |||
| readonly int m_Id = MultiAgentGroupIdCounter.GetGroupId(); | |||
| HashSet<Agent> m_Agents = new HashSet<Agent>(); | |||
|
|
|||
|
|
|||
| /// <summary> | |||
| /// Unregister all member Agents on dispose of SimpleMultiAgentGroup. | |||
There was a problem hiding this comment.
This describes what the code does. I think it should just be Disposes of the SimpleMultiAgentGroup.
dongruoping
reviewed
Mar 12, 2021
| @@ -16,11 +16,13 @@ public interface IMultiAgentGroup | |||
| /// <summary> | |||
| /// Register agent to the MultiAgentGroup. | |||
| /// </summary> | |||
| /// <param name="agent">The Agent to unregister.</param> | |||
There was a problem hiding this comment.
Suggested change
| /// <param name="agent">The Agent to unregister.</param> | |
| /// <param name="agent">The Agent to register.</param> |
dongruoping
approved these changes
Mar 12, 2021
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Proposed change(s)
Added docs that failed the XmlDoc check on the package.
Types of change(s)
Checklist
Other comments