Code Documentation - SelenaYap/Battleship GitHub Wiki

List of Documented Code:

1. DeploymentController

-The whole document in this code's file has been fully documented with summaries for each of the functions. There is no changes found before and after converting into C# code

2. DiscoveryController

-Each of the function has fully documented

3. EndingGameController

-Each of the function has fully documented

4. GameController

-There is about 85% of the functions inside this GameController's file has been documented. Some of the code or functions that are not docummented yet needs to be fix in converted code

5. GameLogic

-The code in this GameLogic's file has been documented everything. There is no any differrent found after converting the code into c# code

6. GameResources

-There is about 50% of the functions inside this GameResources' file has been documented. Some of the code or functions that are not docummented yet needs to be fix in converted code

7. GameState

-The whole document in this code's file has been fully documented with summaries for each of the functions. There is no changes found before and after converting into C# code

8. HighScoreController

-The whole document in this code's file has been fully documented with summaries for each of the functions. There is no changes found before and after converting into C# code

9. MenuController

-The code in this MenuController's file has been documented everything. There is no any differrent found after converting the code into c# code

10. UtilityFunctions

-There is about 50% of the functions inside this UtilityFunctions' file has been documented. Some of the code or functions that are not docummented yet needs to be fix in converted code

11. ShipName

-This file only contain a very little of documented VB code and converted code

  1. Tile -The whole document in this code's file has been fully documented with summaries for each of the functions. There is no changes found before and after converting into C# code

13. TileView

-The code in this TileView's file has been documented everything. There is no any differrent found after converting the code into c# code