Skip to content

Commit

Permalink
Docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
@ZorPastaman
ZorPastaman committed Mar 11, 2021
1 parent 637e4e9 commit 12384cc
Show file tree
Hide file tree
Showing 15 changed files with 191 additions and 163 deletions.
2 changes: 1 addition & 1 deletion Editor/EditorTools/BlackboardTableEditor.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ protected abstract void GetProperties([NotNull] Blackboard blackboard,

/// <summary>
/// Sets <paramref name="value"/> into <paramref name="blackboard"/>
/// with property name <paramref name="key"/>.
/// with <paramref name="key"/> as a property name.
/// </summary>
/// <param name="blackboard">Property is set into this.</param>
/// <param name="key">Property name.</param>
Expand Down
174 changes: 99 additions & 75 deletions README.md
View file

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions Runtime/Components/AccessorFlushers/AccessorFlusher.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,18 +30,18 @@ public int accessorsCount
}

/// <summary>
/// Gets a <see cref="Accessor_Base"/> at the index <paramref name="index"/>.
/// Gets a <see cref="Accessor_Base"/> at the <paramref name="index"/>.
/// </summary>
/// <param name="index"></param>
/// <returns><see cref="Accessor_Base"/> at the index <paramref name="index"/>.</returns>
/// <returns><see cref="Accessor_Base"/> at the <paramref name="index"/>.</returns>
[MethodImpl(MethodImplOptions.AggressiveInlining), NotNull, Pure]
public Accessor_Base GetAccessor(int index)
{
return m_Accessors[index];
}

/// <summary>
/// Sets the accessor <paramref name="accessor"/> at the index <paramref name="index"/>
/// Sets the <paramref name="accessor"/> at the <paramref name="index"/>
/// </summary>
/// <param name="accessor"></param>
/// <param name="index"></param>
Expand All @@ -52,7 +52,7 @@ public void SetAccessor([NotNull] Accessor_Base accessor, int index)
}

/// <summary>
/// Sets the accessors <paramref name="accessors"/>.
/// Sets the <paramref name="accessors"/>.
/// </summary>
/// <param name="accessors"></param>
public void SetAccessors([NotNull] Accessor_Base[] accessors)
Expand Down
14 changes: 7 additions & 7 deletions Runtime/Components/SimpleBlackboardContainer.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,10 +60,10 @@ public int componentReferencesCount
}

/// <summary>
/// Gets a <see cref="SimpleSerializedContainer"/> at the index <paramref name="index"/>.
/// Gets a <see cref="SimpleSerializedContainer"/> at the <paramref name="index"/>.
/// </summary>
/// <param name="index"></param>
/// <returns><see cref="SimpleSerializedContainer"/> at the index <paramref name="index"/>.</returns>
/// <returns><see cref="SimpleSerializedContainer"/> at the <paramref name="index"/>.</returns>
/// <remarks>
/// If you change a gotten <see cref="SetSerializedContainer"/>,
/// you need to call <see cref="RecreateBlackboard"/> to apply changes.
Expand All @@ -75,7 +75,7 @@ public SimpleSerializedContainer GetSerializedContainer(int index)
}

/// <summary>
/// Sets the serialized container <paramref name="serializedContainer"/> at the index <paramref name="index"/>
/// Sets the <paramref name="serializedContainer"/> at the <paramref name="index"/>
/// </summary>
/// <param name="serializedContainer"></param>
/// <param name="index"></param>
Expand All @@ -89,7 +89,7 @@ public void SetSerializedContainer([NotNull] SimpleSerializedContainer serialize
}

/// <summary>
/// Sets the serialized containers <paramref name="serializedContainers"/>.
/// Sets the <paramref name="serializedContainers"/>.
/// </summary>
/// <param name="serializedContainers"></param>
/// <remarks>
Expand All @@ -108,18 +108,18 @@ public void SetSerializedContainers([NotNull] SimpleSerializedContainer[] serial
}

/// <summary>
/// Gets a <see cref="ComponentReference"/> at the index <paramref name="index"/>.
/// Gets a <see cref="ComponentReference"/> at the <paramref name="index"/>.
/// </summary>
/// <param name="index"></param>
/// <returns><see cref="ComponentReference"/> at the index <paramref name="index"/>.</returns>
/// <returns><see cref="ComponentReference"/> at the <paramref name="index"/>.</returns>
[MethodImpl(MethodImplOptions.AggressiveInlining), Pure]
public ComponentReference GetComponentReference(int index)
{
return m_ComponentReferences[index];
}

/// <summary>
/// Sets the component reference <paramref name="componentReference"/> at the index <paramref name="index"/>.
/// Sets the component reference <paramref name="componentReference"/> at the <paramref name="index"/>.
/// </summary>
/// <param name="componentReference"></param>
/// <param name="index"></param>
Expand Down
109 changes: 57 additions & 52 deletions Runtime/Core/Blackboard.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ public int propertiesCount

/// <summary>
/// Tries to get and return a value of the struct type <typeparamref name="T"/>
/// and the property name <paramref name="propertyName"/>.
/// and the <paramref name="propertyName"/>.
/// </summary>
/// <param name="propertyName">Name of the value property to get.</param>
/// <param name="value">If the property is found, this contains its value; otherwise
Expand Down Expand Up @@ -95,7 +95,7 @@ public bool TryGetStructValue<T>(BlackboardPropertyName propertyName, out T valu

/// <summary>
/// Tries to get and return a value of the class type <typeparamref name="T"/>
/// and the property name <paramref name="propertyName"/>.
/// and the <paramref name="propertyName"/>.
/// </summary>
/// <param name="propertyName">Name of the value property to get.</param>
/// <param name="value">If the property is found, this contains its value; otherwise
Expand All @@ -121,7 +121,7 @@ public bool TryGetClassValue<T>(BlackboardPropertyName propertyName, [CanBeNull]

/// <summary>
/// Tries to get and return a value of the type <paramref name="valueType"/>
/// and the property name <paramref name="propertyName"/>.
/// and the <paramref name="propertyName"/>.
/// </summary>
/// <param name="valueType">Type of the value to get.</param>
/// <param name="propertyName">Name of the value property to get.</param>
Expand Down Expand Up @@ -157,7 +157,7 @@ public bool TryGetObjectValue([NotNull] Type valueType, BlackboardPropertyName p
}

/// <summary>
/// Tries to get and return a value of the property name <paramref name="propertyName"/>.
/// Tries to get and return a value of the <paramref name="propertyName"/>.
/// </summary>
/// <param name="propertyName">Name of the value property to get.</param>
/// <param name="value">If the property is found, this contains its value; otherwise
Expand Down Expand Up @@ -189,8 +189,8 @@ public bool TryGetObjectValue(BlackboardPropertyName propertyName, [CanBeNull] o
}

/// <summary>
/// Sets the value <paramref name="value"/> of the struct type <typeparamref name="T"/>
/// and the property name <paramref name="propertyName"/>.
/// Sets the <paramref name="value"/> of the struct type <typeparamref name="T"/>
/// and the <paramref name="propertyName"/>.
/// </summary>
/// <param name="propertyName">Name of the value property to set.</param>
/// <param name="value">Value to set.</param>
Expand Down Expand Up @@ -233,16 +233,16 @@ public void SetStructValue<T>(BlackboardPropertyName propertyName, T value) wher
}

/// <summary>
/// Sets the value <paramref name="value"/> of the class type <typeparamref name="T"/>
/// and the property name <paramref name="propertyName"/>.
/// Sets the <paramref name="value"/> of the class type <typeparamref name="T"/>
/// and the <paramref name="propertyName"/>.
/// </summary>
/// <param name="propertyName">Name of the value property to set.</param>
/// <param name="value">Value to set.</param>
/// <typeparam name="T">Class value type to set.</typeparam>
/// <remarks>This method allocates if a property of the type <typeparamref name="T"/> is set first
/// or when the internal table resizes.</remarks>
/// <remarks>
/// <para>If the <see cref="Blackboard"/> contains a property of the property name <paramref name="propertyName"/>,
/// <para>If the <see cref="Blackboard"/> contains a property of the <paramref name="propertyName"/>,
/// it replaces that property with the new one.</para>
/// </remarks>
/// <seealso cref="SetStructValue{T}"/>
Expand Down Expand Up @@ -281,16 +281,16 @@ public void SetClassValue<T>(BlackboardPropertyName propertyName, [CanBeNull] T
}

/// <summary>
/// Sets the value <paramref name="value"/> of the type <paramref name="valueType"/>
/// and the property name <paramref name="propertyName"/>.
/// Sets the <paramref name="value"/> of the type <paramref name="valueType"/>
/// and the <paramref name="propertyName"/>.
/// </summary>
/// <param name="valueType">Value type to set.</param>
/// <param name="propertyName">Name of the value property to set.</param>
/// <param name="value">Value to set.</param>
/// <remarks>
/// <para>This method allocates if a property of the type <paramref name="valueType"/> is set first
/// or when the internal table resizes.</para>
/// <para>If the <see cref="Blackboard"/> contains a property of the property name <paramref name="propertyName"/>,
/// <para>If the <see cref="Blackboard"/> contains a property of the <paramref name="propertyName"/>,
/// it replaces that property with the new one.</para>
/// </remarks>
/// <seealso cref="SetStructValue{T}"/>
Expand Down Expand Up @@ -444,11 +444,12 @@ public void GetObjectProperties([NotNull] List<KeyValuePair<BlackboardPropertyNa
}

/// <summary>
/// Gets value type of a property with the property name <paramref name="propertyName"/>.
/// Gets value type of a property with the <paramref name="propertyName"/>.
/// </summary>
/// <param name="propertyName"></param>
/// <returns>Type of a property with the property name <paramref name="propertyName"/>
/// or null if such a property is not found.</returns>
/// <returns>
/// Type of a property with the <paramref name="propertyName"/> or null if such a property is not found.
/// </returns>
/// <seealso cref="GetValueTypes"/>
[MethodImpl(MethodImplOptions.AggressiveInlining), Pure]
public Type GetValueType(BlackboardPropertyName propertyName)
Expand Down Expand Up @@ -495,7 +496,7 @@ public void GetPropertyNames([NotNull] List<BlackboardPropertyName> propertyName

/// <summary>
/// Checks if the <see cref="Blackboard"/> contains a property of
/// the property name <paramref name="propertyName"/> and the struct type <typeparamref name="T"/>.
/// the <paramref name="propertyName"/> and the struct type <typeparamref name="T"/>.
/// </summary>
/// <param name="propertyName">Name of the value property to find.</param>
/// <typeparam name="T">Struct value type.</typeparam>
Expand All @@ -519,7 +520,7 @@ public bool ContainsStructValue<T>(BlackboardPropertyName propertyName) where T

/// <summary>
/// Checks if the <see cref="Blackboard"/> contains a property of
/// the property name <paramref name="propertyName"/> and the type <typeparamref name="T"/>.
/// the <paramref name="propertyName"/> and the type <typeparamref name="T"/>.
/// </summary>
/// <param name="propertyName">Name of the value property to find.</param>
/// <typeparam name="T">Value type.</typeparam>
Expand All @@ -544,7 +545,7 @@ public bool ContainsObjectValue<T>(BlackboardPropertyName propertyName)

/// <summary>
/// Checks if the <see cref="Blackboard"/> contains a property of
/// the property name <paramref name="propertyName"/> and the type <paramref name="valueType"/>.
/// the <paramref name="propertyName"/> and the type <paramref name="valueType"/>.
/// </summary>
/// <param name="valueType">Value type.</param>
/// <param name="propertyName">Name of the value property to find.</param>
Expand All @@ -568,8 +569,7 @@ public bool ContainsObjectValue([NotNull] Type valueType, BlackboardPropertyName
}

/// <summary>
/// Checks if the <see cref="Blackboard"/> contains a property of
/// the property name <paramref name="propertyName"/>.
/// Checks if the <see cref="Blackboard"/> contains a property of the <paramref name="propertyName"/>.
/// </summary>
/// <param name="propertyName">Name of the value property to find.</param>
/// <returns>
Expand All @@ -591,8 +591,8 @@ public bool ContainsObjectValue(BlackboardPropertyName propertyName)
}

/// <summary>
/// Checks if the <see cref="Blackboard"/> contains or contained
/// a property of the type <typeparamref name="T"/>.
/// Checks if the <see cref="Blackboard"/> contains
/// or contained a property of the type <typeparamref name="T"/>.
/// </summary>
/// <typeparam name="T">Value type.</typeparam>
/// <returns>
Expand All @@ -617,8 +617,8 @@ public bool ContainsType<T>()
}

/// <summary>
/// Checks if the <see cref="Blackboard"/> contains or contained
/// a property of the type <paramref name="valueType"/>.
/// Checks if the <see cref="Blackboard"/> contains
/// or contained a property of the type <paramref name="valueType"/>.
/// </summary>
/// <param name="valueType">Value type.</param>
/// <returns>
Expand All @@ -643,8 +643,8 @@ public bool ContainsType([NotNull] Type valueType)
}

/// <summary>
/// Checks if the <see cref="Blackboard"/> contains or contained
/// a property of the type <typeparamref name="T"/>.
/// Checks if the <see cref="Blackboard"/> contains
/// or contained a property of the type <typeparamref name="T"/>.
/// </summary>
/// <typeparam name="T">Value type.</typeparam>
/// <returns>
Expand All @@ -666,8 +666,8 @@ public bool ContainsInheritingType<T>()
}

/// <summary>
/// Checks if the <see cref="Blackboard"/> contains or contained
/// a property of the type <paramref name="valueType"/>.
/// Checks if the <see cref="Blackboard"/> contains
/// or contained a property of the type <paramref name="valueType"/>.
/// </summary>
/// <param name="valueType">Value type.</param>
/// <returns>
Expand Down Expand Up @@ -705,10 +705,12 @@ bool ICollection<KeyValuePair<BlackboardPropertyName, object>>.Contains(KeyValue
/// </summary>
/// <typeparam name="T">Value type.</typeparam>
/// <returns>
/// <para>How many values of the type <typeparamref name="T"/>
/// are contained in the <see cref="Blackboard"/>.</para>
/// <para>-1 if the <see cref="Blackboard"/> doesn't contain a value
/// of the type <typeparamref name="T"/>.</para>
/// <para>
/// How many values of the type <typeparamref name="T"/> are contained in the <see cref="Blackboard"/>.
/// </para>
/// <para>
/// -1 if the <see cref="Blackboard"/> doesn't contain a value of the type <typeparamref name="T"/>.
/// </para>
/// </returns>
/// <remarks>
/// This method doesn't support derivation.
Expand Down Expand Up @@ -736,10 +738,12 @@ public int GetCount<T>()
/// </summary>
/// <param name="valueType">Value type.</param>
/// <returns>
/// <para>How many values of the type <paramref name="valueType"/>
/// are contained in the <see cref="Blackboard"/>.</para>
/// <para>-1 if the <see cref="Blackboard"/> doesn't contain a value
/// of the type <paramref name="valueType"/>.</para>
/// <para>
/// How many values of the type <paramref name="valueType"/> are contained in the <see cref="Blackboard"/>.
/// </para>
/// <para>
/// -1 if the <see cref="Blackboard"/> doesn't contain a value of the type <paramref name="valueType"/>.
/// </para>
/// </returns>
/// <remarks>
/// This method doesn't support derivation.
Expand All @@ -766,10 +770,12 @@ public int GetCount([NotNull] Type valueType)
/// </summary>
/// <typeparam name="T">Value type.</typeparam>
/// <returns>
/// <para>How many values of the type <typeparamref name="T"/>
/// are contained in the <see cref="Blackboard"/>.</para>
/// <para>-1 if the <see cref="Blackboard"/> doesn't contain a value
/// of the type <typeparamref name="T"/>.</para>
/// <para>
/// How many values of the type <typeparamref name="T"/> are contained in the <see cref="Blackboard"/>.
/// </para>
/// <para>
/// -1 if the <see cref="Blackboard"/> doesn't contain a value of the type <typeparamref name="T"/>.
/// </para>
/// </returns>
/// <seealso cref="GetCount{T}"/>
/// <seealso cref="GetCount"/>
Expand All @@ -792,10 +798,12 @@ public int GetCountWithInheritors<T>()
/// </summary>
/// <param name="valueType">Value type.</param>
/// <returns>
/// <para>How many values of the type <paramref name="valueType"/>
/// are contained in the <see cref="Blackboard"/>.</para>
/// <para>-1 if the <see cref="Blackboard"/> doesn't contain a value
/// of the type <paramref name="valueType"/>.</para>
/// <para>
/// How many values of the type <paramref name="valueType"/> are contained in the <see cref="Blackboard"/>.
/// </para>
/// <para>
/// -1 if the <see cref="Blackboard"/> doesn't contain a value of the type <paramref name="valueType"/>.
/// </para>
/// </returns>
/// <seealso cref="GetCount{T}"/>
/// <seealso cref="GetCount"/>
Expand Down Expand Up @@ -829,8 +837,7 @@ public int GetCountWithInheritors([NotNull] Type valueType)
}

/// <summary>
/// Removes a property of the property name <paramref name="propertyName"/>
/// and the struct type <typeparamref name="T"/>.
/// Removes a property of the <paramref name="propertyName"/> and the struct type <typeparamref name="T"/>.
/// </summary>
/// <param name="propertyName">Name of the property to remove.</param>
/// <typeparam name="T">Struct value type.</typeparam>
Expand Down Expand Up @@ -864,8 +871,7 @@ public bool RemoveStruct<T>(BlackboardPropertyName propertyName) where T : struc
}

/// <summary>
/// Removes a property of the property name <paramref name="propertyName"/> and
/// the type <typeparamref name="T"/>.
/// Removes a property of the p<paramref name="propertyName"/> and the type <typeparamref name="T"/>.
/// </summary>
/// <param name="propertyName">Name of the property to remove.</param>
/// <typeparam name="T">Value type.</typeparam>
Expand Down Expand Up @@ -898,8 +904,7 @@ public bool RemoveObject<T>(BlackboardPropertyName propertyName)
}

/// <summary>
/// Removes a property of the property name <paramref name="propertyName"/>
/// and the type <paramref name="valueType"/>.
/// Removes a property of the <paramref name="propertyName"/> and the type <paramref name="valueType"/>.
/// </summary>
/// <param name="valueType">Value type.</param>
/// <param name="propertyName">Name of the property to remove.</param>
Expand Down Expand Up @@ -930,7 +935,7 @@ public bool RemoveObject([NotNull] Type valueType, BlackboardPropertyName proper
}

/// <summary>
/// Removes a property of the property name <paramref name="propertyName"/>.
/// Removes a property of the <paramref name="propertyName"/>.
/// </summary>
/// <param name="propertyName">Name of the property to remove.</param>
/// <returns>True if the property is removed; false if it doesn't exist.</returns>
Expand Down Expand Up @@ -1034,7 +1039,7 @@ public void CopyTo([NotNull] Blackboard blackboard)
}

/// <summary>
/// Copies a property of the property name <paramref name="propertyName"/> into <paramref name="blackboard"/>.
/// Copies a property of the <paramref name="propertyName"/> into <paramref name="blackboard"/>.
/// </summary>
/// <param name="blackboard">Destination.</param>
/// <param name="propertyName">Property to copy.</param>
Expand Down
Loading

0 comments on commit 12384cc

Please sign in to comment.