Related Jira Issues

Introduction

The following documentation defines the means by which code will be commented and the types of documentation that will be produced. It should be noted that the Programming Style Guide contains its own guide to general commenting practice. Should this document and the Style Guide conflict when it pertains to commenting code, this document will take precedence. Please notify the Project Lead of any discrepancies between this document and the Style Guide so that they may be addressed.

...

• 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

• Documentation generated from the xmldoc comments will be provided

• Code samples will be written to assist users with familiarizing themselves with the SDK