1
0
Fork 0
mirror of https://github.com/sbrl/Nibriboard.git synced 2018-01-10 21:33:49 +00:00

Add intellisense description to each core structure class.

This commit is contained in:
Starbeamrainbowlabs 2017-01-06 19:05:27 +00:00
parent bd2932832b
commit c9bd9b3219
6 changed files with 23 additions and 0 deletions

View file

@ -1,6 +1,9 @@
using System; using System;
namespace Nibriboard.RippleSpace namespace Nibriboard.RippleSpace
{ {
/// <summary>
/// Represents a single chunk of an infinite <see cref="Nibriboard.RippleSpace.Plane" />.
/// </summary>
public class Chunk public class Chunk
{ {
public Chunk() public Chunk()

View file

@ -1,6 +1,14 @@
using System; using System;
namespace Nibriboard.RippleSpace namespace Nibriboard.RippleSpace
{ {
/// <summary>
/// References the location of a chunk.
/// </summary>
/// <remarks>
/// Defaults to chunk-space, but absolute plane-space can also be calculated
/// and obtained (A <see cref="Nibriboard.RippleSpace.LocationReference" />
/// is returned).
/// </remarks>
public class ChunkReference : Reference public class ChunkReference : Reference
{ {
public ChunkReference() public ChunkReference()

View file

@ -1,6 +1,9 @@
using System; using System;
namespace Nibriboard.RippleSpace namespace Nibriboard.RippleSpace
{ {
/// <summary>
/// Represents a line drawn across the plane.
/// </summary>
public class DrawnLine public class DrawnLine
{ {
public DrawnLine() public DrawnLine()

View file

@ -1,6 +1,9 @@
using System; using System;
namespace Nibriboard.RippleSpace namespace Nibriboard.RippleSpace
{ {
/// <summary>
/// Represents a location in absolute plane-space.
/// </summary>
public class LocationReference : Reference public class LocationReference : Reference
{ {
public LocationReference() public LocationReference()

View file

@ -1,6 +1,9 @@
using System; using System;
namespace Nibriboard.RippleSpace namespace Nibriboard.RippleSpace
{ {
/// <summary>
/// Represents an infinite plane.
/// </summary>
public class Plane public class Plane
{ {
public Plane() public Plane()

View file

@ -2,6 +2,9 @@
using System.Security.Policy; using System.Security.Policy;
namespace Nibriboard.RippleSpace namespace Nibriboard.RippleSpace
{ {
/// <summary>
/// An abstract class representing a coordinate reference to a location.
/// </summary>
public abstract class Reference public abstract class Reference
{ {
public int X { get; set; } public int X { get; set; }