Skip to content

Commit 8c3a824

Browse files
Implemented recommended XML tags to file headers
1 parent 0e5ee04 commit 8c3a824

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

Editor/GenerateFileEditorWindow.cs

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,10 +97,12 @@ private void Generate () {
9797
_importCommonNamespaces ? "using UnityEngine;" : null,
9898
_importCommonNamespaces ? "using System.Collections.Generic;" : null,
9999
"",
100+
_addFileHeaderComments ? "/// <summary>" : null,
100101
_addFileHeaderComments ? "/// Project: " + PlayerSettings.productName : null,
101102
_addFileHeaderComments ? "/// Author: " : null,
102103
_addFileHeaderComments ? "/// Created: " + _dateTimeStamp : null,
103104
_addFileHeaderComments ? "/// Controller for " + _fileName + "." : null,
105+
_addFileHeaderComments ? "/// </summary>" : null,
104106
"public class " + _fileName + "Controller : Controller {",
105107
"\tpublic override void OnInitialize () {",
106108
"\t\tthis.Register();",
@@ -117,10 +119,12 @@ private void Generate () {
117119
_importCommonNamespaces ? "using UnityEngine;" : null,
118120
_importCommonNamespaces ? "using System.Collections.Generic;" : null,
119121
"",
122+
_addFileHeaderComments ? "/// <summary>" : null,
120123
_addFileHeaderComments ? "/// Project: " + PlayerSettings.productName : null,
121124
_addFileHeaderComments ? "/// Author: " : null,
122125
_addFileHeaderComments ? "/// Created: " + _dateTimeStamp : null,
123126
_addFileHeaderComments ? "/// Entity Component for " + _fileName + "." : null,
127+
_addFileHeaderComments ? "/// </summary>" : null,
124128
"public class " + _fileName + "Component : EntityComponent<" + _fileName + "Component, " + _fileName + "System> {",
125129
"}"
126130
});
@@ -131,10 +135,12 @@ private void Generate () {
131135
_importCommonNamespaces ? "using UnityEngine;" : null,
132136
_importCommonNamespaces ? "using System.Collections.Generic;" : null,
133137
"",
138+
_addFileHeaderComments ? "/// <summary>" : null,
134139
_addFileHeaderComments ? "/// Project: " + PlayerSettings.productName : null,
135140
_addFileHeaderComments ? "/// Author: " : null,
136141
_addFileHeaderComments ? "/// Created: " + _dateTimeStamp : null,
137142
_addFileHeaderComments ? "/// Entity System for " + _fileName + "." : null,
143+
_addFileHeaderComments ? "/// </summary>" : null,
138144
"public class " + _fileName + "System : EntitySystem<" + _fileName + "System, " + _fileName + "Component> {",
139145
_overwriteAllVirtuals ? "\tpublic override void OnInitialize () { }" : null,
140146
_overwriteAllVirtuals ? "\tpublic override void OnInitialized () { }" : null,
@@ -165,10 +171,12 @@ private void Generate () {
165171
_importCommonNamespaces ? "using UnityEngine;" : null,
166172
_importCommonNamespaces ? "using System.Collections.Generic;" : null,
167173
"",
174+
_addFileHeaderComments ? "/// <summary>" : null,
168175
_addFileHeaderComments ? "/// Project: " + PlayerSettings.productName : null,
169176
_addFileHeaderComments ? "/// Author: " : null,
170177
_addFileHeaderComments ? "/// Created: " + _dateTimeStamp : null,
171178
_addFileHeaderComments ? "/// Service for " + _fileName + "." : null,
179+
_addFileHeaderComments ? "/// </summary>" : null,
172180
"public class " + _fileName + "Service : Service<" + _fileName + "Service> {",
173181
_overwriteAllVirtuals ? "\tpublic override void OnInitialize () { }" : null,
174182
_overwriteAllVirtuals ? "\tpublic override void OnInitialized () { }" : null,
@@ -183,10 +191,12 @@ private void Generate () {
183191
_importCommonNamespaces ? "using UnityEngine;" : null,
184192
_importCommonNamespaces ? "using System.Collections.Generic;" : null,
185193
_importCommonNamespaces ? "" : null,
194+
_addFileHeaderComments ? "/// <summary>" : null,
186195
_addFileHeaderComments ? "/// Project: " + PlayerSettings.productName : null,
187196
_addFileHeaderComments ? "/// Author: " : null,
188197
_addFileHeaderComments ? "/// Created: " + _dateTimeStamp : null,
189198
_addFileHeaderComments ? "/// " + _fileName + "." : null,
199+
_addFileHeaderComments ? "/// </summary>" : null,
190200
"public class " + _fileName + " {",
191201
"}"
192202
});

0 commit comments

Comments
 (0)