Skip to content

Commit

Permalink
Xmldoc
Browse files Browse the repository at this point in the history
  • Loading branch information
sk-zk committed Jan 31, 2024
1 parent 9e14567 commit 098b33f
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 12 deletions.
11 changes: 7 additions & 4 deletions TruckLib/ScsMap/FarModel.cs
Original file line number Diff line number Diff line change
Expand Up @@ -34,18 +34,21 @@ public class FarModel : MapItem, IItemReferences
public float Height { get; set; }

/// <summary>
/// Models specific to Far Model items which are only visible inside the Far Model
/// area. Used if UseMapItems is false.
/// Models specific to Far Model items which are only visible inside the area defined
/// by this item.
/// Used if <see cref="UseMapItems">UseMapItems</see> is false.
/// </summary>
public FarModelDataList Models { get; set; }

/// <summary>
/// Map items for which the view distance limit is ignored. Used if UseMapItems is true.
/// Regular map items for which the view distance limit is ignored inside the area defined
/// by this item.
/// Used if <see cref="UseMapItems">UseMapItems</see> is true.
/// </summary>
public List<IMapItem> Children { get; set; }

/// <summary>
/// The map node of the item.
/// The map node of this item.
/// </summary>
public INode Node { get; set; }

Expand Down
16 changes: 8 additions & 8 deletions TruckLib/ScsMap/FarModelDataList.cs
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@
namespace TruckLib.ScsMap
{
/// <summary>
/// Reperesents a list of Far Item models.
/// Reperesents a list of <see cref="FarModel.Models">Far Model models</see>.
/// </summary>
public class FarModelDataList : IList<FarModelData>
{
/// <summary>
/// The Far Model item which parents these models.
/// The <see cref="FarModel">Far Model</see> item which parents these models.
/// </summary>
public FarModel Parent { get; init; }

Expand All @@ -23,7 +23,7 @@ public class FarModelDataList : IList<FarModelData>
/// <summary>
/// Instantiates an empty list.
/// </summary>
/// <param name="parent">The Far Model item which parents these models.</param>
/// <param name="parent">The <see cref="FarModel">Far Model</see> item which parents these models.</param>
public FarModelDataList(FarModel parent)
{
Parent = parent;
Expand All @@ -49,8 +49,8 @@ public void Add(FarModelData item)
}

/// <summary>
/// Creates a map node at the specified position and adds a FarModelData object with
/// the given properties to the end of the list.
/// Creates a map node at the specified position and adds a <see cref="FarModelData"/> object
/// with the given properties to the end of the list.
/// </summary>
/// <param name="position">The position of the node.</param>
/// <param name="model">The unit name of the model.</param>
Expand Down Expand Up @@ -99,10 +99,10 @@ public void Insert(int index, FarModelData item)
}

/// <summary>
/// Creates a map node at the specified position and inserts a FarModelData object with
/// the given properties at the specified index.
/// Creates a map node at the specified position and inserts a <see cref="FarModelData"/> object
/// with the given properties at the specified index.
/// </summary>
/// <param name="index">The index.</param>
/// <param name="index">The zero-based index at which the object should be inserted.</param>
/// <param name="position">The position of the node.</param>
/// <param name="model">The unit name of the model.</param>
/// <param name="scale">The scale of the model.</param>
Expand Down

0 comments on commit 098b33f

Please sign in to comment.