diff options
Diffstat (limited to 'Software/Visual_Studio/Tango.CodeGeneration')
9 files changed, 129 insertions, 0 deletions
diff --git a/Software/Visual_Studio/Tango.CodeGeneration/Class.cs b/Software/Visual_Studio/Tango.CodeGeneration/Class.cs index 45a32ae3e..6f1f4f3b9 100644 --- a/Software/Visual_Studio/Tango.CodeGeneration/Class.cs +++ b/Software/Visual_Studio/Tango.CodeGeneration/Class.cs @@ -6,6 +6,10 @@ using System.Threading.Tasks; namespace Tango.CodeGeneration { + /// <summary> + /// Represents a class code object + /// </summary> + /// <seealso cref="Tango.CodeGeneration.CodeObject" /> public class Class : CodeObject { /// <summary> diff --git a/Software/Visual_Studio/Tango.CodeGeneration/EntityCodeFile.cs b/Software/Visual_Studio/Tango.CodeGeneration/EntityCodeFile.cs index 7de161f71..bc0f37929 100644 --- a/Software/Visual_Studio/Tango.CodeGeneration/EntityCodeFile.cs +++ b/Software/Visual_Studio/Tango.CodeGeneration/EntityCodeFile.cs @@ -6,26 +6,65 @@ using System.Threading.Tasks; namespace Tango.CodeGeneration { + /// <summary> + /// Represents a database entity code file. + /// </summary> + /// <seealso cref="Tango.CodeGeneration.Class" /> public class EntityCodeFile : Class { + /// <summary> + /// Gets or sets the name of the entity. + /// </summary> public String EntityName { get; set; } + /// <summary> + /// Gets or sets the name of the table. + /// </summary> public String TableName { get; set; } + /// <summary> + /// Gets or sets the table fields. + /// </summary> public List<EntityCodeFileField> Fields { get; set; } + /// <summary> + /// Initializes a new instance of the <see cref="EntityCodeFile"/> class. + /// </summary> + /// <param name="name">The code file name.</param> public EntityCodeFile(String name) : base(name) { Fields = new List<EntityCodeFileField>(); } } + /// <summary> + /// Represents a database entity code file field. + /// </summary> public class EntityCodeFileField { + /// <summary> + /// Gets or sets the name. + /// </summary> public String Name { get; set; } + + /// <summary> + /// Gets or sets the name of the field. + /// </summary> public String FieldName { get; set; } + + /// <summary> + /// Gets or sets the type. + /// </summary> public String Type { get; set; } + + /// <summary> + /// Gets or sets the description. + /// </summary> public String Description { get; set; } + + /// <summary> + /// Gets or sets a value indicating whether to initialize this field in the constructor. + /// </summary> public bool Construct { get; set; } } } diff --git a/Software/Visual_Studio/Tango.CodeGeneration/EntityCodeFileJava.cs b/Software/Visual_Studio/Tango.CodeGeneration/EntityCodeFileJava.cs index d2bfd80fc..194cd0fc1 100644 --- a/Software/Visual_Studio/Tango.CodeGeneration/EntityCodeFileJava.cs +++ b/Software/Visual_Studio/Tango.CodeGeneration/EntityCodeFileJava.cs @@ -6,14 +6,31 @@ using System.Threading.Tasks; namespace Tango.CodeGeneration { + /// <summary> + /// Represents a database entity Java code file. + /// </summary> + /// <seealso cref="Tango.CodeGeneration.Class" /> public class EntityCodeFileJava : Class { + /// <summary> + /// Gets or sets the name of the entity. + /// </summary> public String EntityName { get; set; } + /// <summary> + /// Gets or sets the name of the table. + /// </summary> public String TableName { get; set; } + /// <summary> + /// Gets or sets the table fields. + /// </summary> public List<EntityCodeFileField> Fields { get; set; } + /// <summary> + /// Initializes a new instance of the <see cref="EntityCodeFileJava"/> class. + /// </summary> + /// <param name="name">The code file name.</param> public EntityCodeFileJava(String name) : base(name) { Fields = new List<EntityCodeFileField>(); diff --git a/Software/Visual_Studio/Tango.CodeGeneration/EnumerationField.cs b/Software/Visual_Studio/Tango.CodeGeneration/EnumerationField.cs index f8bb98b9b..038055cb9 100644 --- a/Software/Visual_Studio/Tango.CodeGeneration/EnumerationField.cs +++ b/Software/Visual_Studio/Tango.CodeGeneration/EnumerationField.cs @@ -6,10 +6,24 @@ using System.Threading.Tasks; namespace Tango.CodeGeneration { + /// <summary> + /// Represents a single enumeration field. + /// </summary> public class EnumerationField { + /// <summary> + /// Gets or sets the field name. + /// </summary> public String Name { get; set; } + + /// <summary> + /// Gets or sets the value. + /// </summary> public int Value { get; set; } + + /// <summary> + /// Gets or sets an optional description. + /// </summary> public String Description { get; set; } } } diff --git a/Software/Visual_Studio/Tango.CodeGeneration/EnumerationFile.cs b/Software/Visual_Studio/Tango.CodeGeneration/EnumerationFile.cs index e49b7fa48..800513912 100644 --- a/Software/Visual_Studio/Tango.CodeGeneration/EnumerationFile.cs +++ b/Software/Visual_Studio/Tango.CodeGeneration/EnumerationFile.cs @@ -6,12 +6,25 @@ using System.Threading.Tasks; namespace Tango.CodeGeneration { + /// <summary> + /// Represents enumeration code file. + /// </summary> + /// <seealso cref="Tango.CodeGeneration.CodeFile" /> public class EnumerationFile : CodeFile { + /// <summary> + /// Gets or sets enum the name. + /// </summary> public String Name { get; set; } + /// <summary> + /// Gets or sets the collection of enum fields. + /// </summary> public List<EnumerationField> Fields { get; set; } + /// <summary> + /// Initializes a new instance of the <see cref="EnumerationFile"/> class. + /// </summary> public EnumerationFile() { Fields = new List<EnumerationField>(); diff --git a/Software/Visual_Studio/Tango.CodeGeneration/EnumerationFileJava.cs b/Software/Visual_Studio/Tango.CodeGeneration/EnumerationFileJava.cs index 6a42326f7..205e528df 100644 --- a/Software/Visual_Studio/Tango.CodeGeneration/EnumerationFileJava.cs +++ b/Software/Visual_Studio/Tango.CodeGeneration/EnumerationFileJava.cs @@ -6,12 +6,25 @@ using System.Threading.Tasks; namespace Tango.CodeGeneration { + /// <summary> + /// Represents a Java enumeration file. + /// </summary> + /// <seealso cref="Tango.CodeGeneration.CodeFile" /> public class EnumerationFileJava : CodeFile { + /// <summary> + /// Gets or sets the enum name. + /// </summary> public String Name { get; set; } + /// <summary> + /// Gets or sets the collection of enum fields. + /// </summary> public List<EnumerationField> Fields { get; set; } + /// <summary> + /// Initializes a new instance of the <see cref="EnumerationFileJava"/> class. + /// </summary> public EnumerationFileJava() { Fields = new List<EnumerationField>(); diff --git a/Software/Visual_Studio/Tango.CodeGeneration/Helper.cs b/Software/Visual_Studio/Tango.CodeGeneration/Helper.cs index 2e0e449f1..dff85a011 100644 --- a/Software/Visual_Studio/Tango.CodeGeneration/Helper.cs +++ b/Software/Visual_Studio/Tango.CodeGeneration/Helper.cs @@ -10,6 +10,9 @@ using System.Threading.Tasks; namespace Tango.CodeGeneration { + /// <summary> + /// Contains several code generation helper methods. + /// </summary> internal static class Helper { /// <summary> diff --git a/Software/Visual_Studio/Tango.CodeGeneration/ObservablesAdapterFile.cs b/Software/Visual_Studio/Tango.CodeGeneration/ObservablesAdapterFile.cs index 7b1e3d8fe..f62149757 100644 --- a/Software/Visual_Studio/Tango.CodeGeneration/ObservablesAdapterFile.cs +++ b/Software/Visual_Studio/Tango.CodeGeneration/ObservablesAdapterFile.cs @@ -6,6 +6,10 @@ using System.Threading.Tasks; namespace Tango.CodeGeneration { + /// <summary> + /// Represents the Tango DAL layer observables adapter code file. + /// </summary> + /// <seealso cref="Tango.CodeGeneration.Class" /> public class ObservablesAdapterFile : Class { diff --git a/Software/Visual_Studio/Tango.CodeGeneration/TangoDAOJavaFile.cs b/Software/Visual_Studio/Tango.CodeGeneration/TangoDAOJavaFile.cs index 5221365e4..566f13311 100644 --- a/Software/Visual_Studio/Tango.CodeGeneration/TangoDAOJavaFile.cs +++ b/Software/Visual_Studio/Tango.CodeGeneration/TangoDAOJavaFile.cs @@ -6,20 +6,42 @@ using System.Threading.Tasks; namespace Tango.CodeGeneration { + /// <summary> + /// Represents the Tango DAO Java code file. + /// </summary> + /// <seealso cref="Tango.CodeGeneration.CodeFile" /> public class TangoDAOJavaFile : CodeFile { + /// <summary> + /// Gets or sets the class name. + /// </summary> public String Name { get; set; } + /// <summary> + /// Gets or sets the entities. + /// </summary> public List<TangoDAOEntity> Entities { get; set; } + /// <summary> + /// Initializes a new instance of the <see cref="TangoDAOJavaFile"/> class. + /// </summary> public TangoDAOJavaFile() { Entities = new List<TangoDAOEntity>(); } + /// <summary> + /// Represents a Tango DAO Java entity. + /// </summary> public class TangoDAOEntity { + /// <summary> + /// Gets or sets the entity name. + /// </summary> public String Name { get; set; } + + /// <summary> + /// Gets or sets the name of the table. public String TableName { get; set; } } } |