Added XML Headers to generated methods

Author: jeffreylanters

Editor/GenerateFileEditorWindow.cs

@@ -104,11 +104,15 @@ private void Generate () {
           _addFileHeaderComments ? "/// Controller for " + _fileName + "." : null,
           _addFileHeaderComments ? "/// </summary>" : null,
           "public class " + _fileName + "Controller : Controller {",
+          _addFileHeaderComments ? "\t/// <summary>Method invoked when the Controller is initializing.</summary>" : null,
           "\tpublic override void OnInitialize () {",
           "\t\tthis.Register();",
           "\t}",
+          _overwriteAllVirtuals && _addFileHeaderComments ? "\t/// <summary>Method invoked when the Controller is initialized.</summary>" : null,
           _overwriteAllVirtuals ? "\tpublic override void OnInitialized () { }" : null,
+          _overwriteAllVirtuals && _addFileHeaderComments ? "\t/// <summary>Method invoked during the Controller's Update cycle.</summary>" : null,
           _overwriteAllVirtuals ? "\tpublic override void OnUpdate () { }" : null,
+          _overwriteAllVirtuals && _addFileHeaderComments ? "\t/// <summary>Method invoked when the Controller will destroy.</summary>" : null,
           _overwriteAllVirtuals ? "\tpublic override void OnWillDestroy () { }" : null,
           "}"
         });
@@ -142,25 +146,47 @@ private void Generate () {
           _addFileHeaderComments ? "/// Entity System for " + _fileName + "." : null,
           _addFileHeaderComments ? "/// </summary>" : null,
           "public class " + _fileName + "System : EntitySystem<" + _fileName + "System, " + _fileName + "Component> {",
+          _overwriteAllVirtuals && _addFileHeaderComments ? "\t/// <summary>Method invoked when the System is initializing.</summary>" : null,
           _overwriteAllVirtuals ? "\tpublic override void OnInitialize () { }" : null,
+          _overwriteAllVirtuals && _addFileHeaderComments ? "\t/// <summary>Method invoked when the System is initialized.</summary>" : null,
           _overwriteAllVirtuals ? "\tpublic override void OnInitialized () { }" : null,
 #if ECS_PHYSICS
+          _overwriteAllVirtuals && _addFileHeaderComments ? "\t/// <summary>Method invoked during the Controller's Fixed Update cycle.</summary>" : null,
           _overwriteAllVirtuals ? "\tpublic override void OnPhysics () { }" : null,
 #endif
+          _overwriteAllVirtuals && _addFileHeaderComments ? "\t/// <summary>Method invoked during the Controller's Update cycle.</summary>" : null,
           _overwriteAllVirtuals ? "\tpublic override void OnUpdate () { }" : null,
 #if ECS_GRAPHICS
+          _overwriteAllVirtuals && _addFileHeaderComments ? "\t/// <summary>Method invoked during the Controller's Late Update cycle.</summary>" : null,
           _overwriteAllVirtuals ? "\tpublic override void OnRender () { }" : null,
 #endif
+          _overwriteAllVirtuals && _addFileHeaderComments ? "\t/// <summary>Method invoked during the Controller's Gizmos Render cycle.</summary>" : null,
           _overwriteAllVirtuals ? "\tpublic override void OnDrawGizmos () { }" : null,
+          _overwriteAllVirtuals && _addFileHeaderComments ? "\t/// <summary>Method invoked during the Controller's GUI Render cycle.</summary>" : null,
           _overwriteAllVirtuals ? "\tpublic override void OnDrawGui () { }" : null,
+          _overwriteAllVirtuals && _addFileHeaderComments ? "\t/// <summary>Method invoked when the System is enabled.</summary>" : null,
           _overwriteAllVirtuals ? "\tpublic override void OnEnabled () { }" : null,
+          _overwriteAllVirtuals && _addFileHeaderComments ? "\t/// <summary>Method invoked when the System is disabled.</summary>" : null,
           _overwriteAllVirtuals ? "\tpublic override void OnDisabled () { }" : null,
+          _overwriteAllVirtuals && _addFileHeaderComments ? "\t/// <summary>Method invoked when the System will be destroyed.</summary>" : null,
           _overwriteAllVirtuals ? "\tpublic override void OnWillDestroy () { }" : null,
+          _overwriteAllVirtuals && _addFileHeaderComments ? "\t/// <summary>Method invoked when an Entity is initializing.</summary>" : null,
+          _overwriteAllVirtuals && _addFileHeaderComments ? "\t/// <param name=\"entity\">The initializing Entity.</param>" : null,
           _overwriteAllVirtuals ? "\tpublic override void OnEntityInitialize (" + _fileName + "Component entity) { }" : null,
+          _overwriteAllVirtuals && _addFileHeaderComments ? "\t/// <summary>Method invoked when an Entity is initialized.</summary>" : null,
+          _overwriteAllVirtuals && _addFileHeaderComments ? "\t/// <param name=\"entity\">The initialized Entity.</param>" : null,
           _overwriteAllVirtuals ? "\tpublic override void OnEntityInitialized (" + _fileName + "Component entity) { }" : null,
+          _overwriteAllVirtuals && _addFileHeaderComments ? "\t/// <summary>Method invoked when an Entity is enabled.</summary>" : null,
+          _overwriteAllVirtuals && _addFileHeaderComments ? "\t/// <param name=\"entity\">The enabled Entity.</param>" : null,
           _overwriteAllVirtuals ? "\tpublic override void OnEntityEnabled (" + _fileName + "Component entity) { }" : null,
+          _overwriteAllVirtuals && _addFileHeaderComments ? "\t/// <summary>Method invoked when an Entity is disabled.</summary>" : null,
+          _overwriteAllVirtuals && _addFileHeaderComments ? "\t/// <param name=\"entity\">The disabled Entity.</param>" : null,
           _overwriteAllVirtuals ? "\tpublic override void OnEntityDisabled (" + _fileName + "Component entity) { }" : null,
+          _overwriteAllVirtuals && _addFileHeaderComments ? "\t/// <summary>Method invoked when an Entity will be destroyed.</summary>" : null,
+          _overwriteAllVirtuals && _addFileHeaderComments ? "\t/// <param name=\"entity\">The to be destroyed Entity.</param>" : null,
           _overwriteAllVirtuals ? "\tpublic override void OnEntityWillDestroy (" + _fileName + "Component entity) { }" : null,
+          _overwriteAllVirtuals && _addFileHeaderComments ? "\t/// <summary>Method incidates whether the System should Update.</summary>" : null,
+          _overwriteAllVirtuals && _addFileHeaderComments ? "\t/// <returns>Whether the Controller should update this system.</returns>" : null,
           _overwriteAllVirtuals ? "\tpublic override bool ShouldUpdate () { return true; }" : null,
           "}"
         });
@@ -178,10 +204,15 @@ private void Generate () {
           _addFileHeaderComments ? "/// Service for " + _fileName + "." : null,
           _addFileHeaderComments ? "/// </summary>" : null,
           "public class " + _fileName + "Service : Service<" + _fileName + "Service> {",
+          _overwriteAllVirtuals && _addFileHeaderComments ? "\t/// <summary>Method invoked when the Service is initializing.</summary>" : null,
           _overwriteAllVirtuals ? "\tpublic override void OnInitialize () { }" : null,
+          _overwriteAllVirtuals && _addFileHeaderComments ? "\t/// <summary>Method invoked when the Service is initialized.</summary>" : null,
           _overwriteAllVirtuals ? "\tpublic override void OnInitialized () { }" : null,
+          _overwriteAllVirtuals && _addFileHeaderComments ? "\t/// <summary>Method invoked during the Controller's Gizmos Render cycle.</summary>" : null,
           _overwriteAllVirtuals ? "\tpublic override void OnDrawGizmos () { }" : null,
+          _overwriteAllVirtuals && _addFileHeaderComments ? "\t/// <summary>Method invoked during the Controller's GUI Render cycle.</summary>" : null,
           _overwriteAllVirtuals ? "\tpublic override void OnDrawGui () { }" : null,
+          _overwriteAllVirtuals && _addFileHeaderComments ? "\t/// <summary>Method invoked when the Service will be destoryed.</summary>" : null,
           _overwriteAllVirtuals ? "\tpublic override void OnWillDestroy () { }" : null,
           "}"
         });