Skip to content

Commit

Permalink
[docs] Add missing package docs (#5108)
Browse files Browse the repository at this point in the history
* Add missing package docs

* Fix grammar

* Update comment on Dispose

* Fix typo in doc
  • Loading branch information
Ervin T authored Mar 15, 2021
1 parent a3802a6 commit 1c9b3ff
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 1 deletion.
2 changes: 2 additions & 0 deletions com.unity.ml-agents/Runtime/IMultiAgentGroup.cs
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,13 @@ public interface IMultiAgentGroup
/// <summary>
/// Register agent to the MultiAgentGroup.
/// </summary>
/// <param name="agent">The Agent to register.</param>
void RegisterAgent(Agent agent);

/// <summary>
/// Unregister agent from the MultiAgentGroup.
/// </summary>
/// <param name="agent">The Agent to unregister.</param>
void UnregisterAgent(Agent agent);
}
}
7 changes: 7 additions & 0 deletions com.unity.ml-agents/Runtime/Sensors/BufferSensor.cs
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,13 @@ public class BufferSensor : ISensor, IDimensionPropertiesSensor, IBuiltInSensor
DimensionProperty.VariableSize,
DimensionProperty.None
};

/// <summary>
/// Creates the BufferSensor.
/// </summary>
/// <param name="maxNumberObs">The maximum number of observations to be appended to this BufferSensor.</param>
/// <param name="obsSize">The size of each observation appended to the BufferSensor.</param>
/// <param name="name">The name of the sensor.</param>
public BufferSensor(int maxNumberObs, int obsSize, string name)
{
m_Name = name;
Expand Down
4 changes: 3 additions & 1 deletion com.unity.ml-agents/Runtime/SimpleMultiAgentGroup.cs
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@ public class SimpleMultiAgentGroup : IMultiAgentGroup, IDisposable
readonly int m_Id = MultiAgentGroupIdCounter.GetGroupId();
HashSet<Agent> m_Agents = new HashSet<Agent>();


/// <summary>
/// Disposes of the SimpleMultiAgentGroup.
/// </summary>
public virtual void Dispose()
{
while (m_Agents.Count > 0)
Expand Down

0 comments on commit 1c9b3ff

Please sign in to comment.