Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
/// <example>
/// <code>
/// int c = Math.Add(4, 5);
/// if (c > 10)
/// {
///     Console.WriteLine(c);
/// }
/// </code>
/// </example>
public static int Add(int left, int right)
{
    if ((left == int.MaxValue && right > 0) || (right == int.MaxValue && left > 0))
        throw new System.OverflowException();

    return left + right;
}

Documentation

  • Any public facing classes will have an associated Class Diagram to outline its general makeup

  • Public facing classes within the Communications API will have sequence diagrams built to outline the general flow of communication between the device and the SDK

  • Documentation describing the general usage of the SDK will be provided

  • Documentation describing the makeup of the Unity example scene will be provided

  • Documentation describing how users can make use of the VictoR SDK Unity package will be provided