/// <summary>Adds Class Comments to a Generated Field Class</summary> /// <param name="genClass">a GeneratedConformanceContainer /// </param> /// <param name="field">the field for which the comments are being added to /// </param> public void decorateField(GeneratedConformanceContainer genClass, Field field) { genClass.addClassComment("This represents a constrained " + field.Name + " field, with the following proerties:"); genClass.addClassComment("<table>"); addOptionalComment(genClass, "Name", field.Name); addOptionalComment(genClass, "Usage", field.Usage); addOptionalComment(genClass, "Description", field.Description); addOptionalComment(genClass, "Implementation Note", field.ImpNote); addOptionalComment(genClass, "Predicate", field.Predicate); addOptionalComment(genClass, "Reference", field.Reference); addOptionalComment(genClass, "Minimum Repetitions ", field.Min + ""); addOptionalComment(genClass, "Maximum Repetitions ", field.Max + ""); genClass.addClassComment("</table>"); }
/// <summary>Adds Class Comments to a Generated Class</summary> /// <param name="genClass">a GeneratedConformanceContainer /// </param> /// <param name="ps">the Profile Structure for which the comments are being added to /// </param> public void decorateProfileStructure(GeneratedConformanceContainer genClass, ProfileStructure ps) { genClass.addClassComment("This represents a constrained " + ps.Name + " segment, with the following properties:"); genClass.addClassComment("<table>"); addOptionalComment(genClass, "Name", ps.Name); addOptionalComment(genClass, "Usage", ps.Usage); addOptionalComment(genClass, "Description", ps.Description); addOptionalComment(genClass, "Implementation Note", ps.ImpNote); addOptionalComment(genClass, "Predicate", ps.Predicate); addOptionalComment(genClass, "Reference", ps.Reference); addOptionalComment(genClass, "Minimum Repetitions ", ps.Min + ""); addOptionalComment(genClass, "Maximum Repetitions ", ps.Max + ""); genClass.addClassComment("</table>"); }
/// <summary>Adds a label and it data value to GeneratedClass Comments in a table format</summary> /// <param name="genClass">a GeneratedConformanceContainer /// </param> /// <param name="label">optional comment label to add to the class header document table /// </param> /// <param name="data">the data value to add to the class header document table /// </param> private void addOptionalComment(GeneratedConformanceContainer genClass, System.String label, System.String data) { if (data != null && (System.Object)data != (System.Object) "") { genClass.addClassComment(" <tr><td>" + label + "</td><td>" + data + "</td></tr>"); } }
/// <summary>Adds a table of comments to a Generated Component Class</summary> /// <param name="genClass">a GeneratedConformanceContainer /// </param> /// <param name="comp">the component for which the comments are being added to /// </param> public void decorateComponent(GeneratedConformanceContainer genClass, Component comp) { genClass.addClassComment("This class contains and provides access to all SubComponents"); genClass.addClassComment("<table>"); addOptionalComment(genClass, "Name", comp.Name); addOptionalComment(genClass, "Usage", comp.Usage); addOptionalComment(genClass, "Data Type", comp.Datatype); addOptionalComment(genClass, "Constant Value", comp.ConstantValue); addOptionalComment(genClass, "Description", comp.Description); addOptionalComment(genClass, "Implementation Note", comp.ImpNote); addOptionalComment(genClass, "Predicate", comp.Predicate); addOptionalComment(genClass, "Reference", comp.Reference); addOptionalComment(genClass, "Length", comp.Length + ""); if (comp.Length != 0) { addOptionalComment(genClass, "Table", comp.Table + ""); } genClass.addClassComment("</table>"); }