/// <summary>Adds comments to a generated constructor</summary>
/// <param name="constructor">a constructor to add comments to
/// </param>
/// <param name="msg">the message
/// </param>
public void decorateConstructor(GeneratedMethod constructor, System.String className)
{
constructor.addToDescription("Default constructor for Conformance_HL7_" + className + ". Has the");
constructor.addToDescription("following functions:");
constructor.addToDescription("<ul><li>Instantiating all required Conformance Classes in the structure");
constructor.addToDescription(" <li>Instantiating the underlying HAPI Message object");
constructor.addToDescription(" <li>Populating any constant values");
constructor.addToDescription("</ul>");
}
public void decorateSetValue(GeneratedMethod genMethod, long maxLength)
{
genMethod.addToDescription("This method validates the <code>String</code> value passed in to be no greater then the");
genMethod.addToDescription("maximum allowable length for the extending class. If the <code>String</code> value is valid, this");
genMethod.addToDescription("method will set the underlying HAPI class's value. If the data passed in is invalid for the given");
genMethod.addToDescription("data type, a ConformanceException is thrown.");
genMethod.addToDescription("@throws ConfDataException if the data is invalid for the given datatype");
//TODO: this probably isn't the right exception type
genMethod.addToDescription("@param value The value to be set.");
if (maxLength > 0)
{
genMethod.addToDescription("Note: The value has a maximum length of " + maxLength);
}
}
/// <summary>Adds Class Comments to a Minimum Repition Method</summary>
/// <param name="genClass">a GeneratedConformanceContainer
/// </param>
/// <param name="genMethod">the GeneratedMethod for which the comments are being added to
/// </param>
public void decorateMinReps(GeneratedMethod genMethod)
{
genMethod.addToDescription("This method returns the minimum allowable");
genMethod.addToComments("repetitions of this object.");
genMethod.addToComments("@return minimum allowable repetitions");
}
/// <summary>Adds Class Comments to a getMaxLength method</summary>
/// <param name="genMethod">a GeneratedMethod
/// </param>
public void decorateMaxLength(GeneratedMethod genMethod)
{
genMethod.addToDescription("Returns the Maximum allowable length for the Data Type");
genMethod.addToComments("@return the maximum allowable length of the Data Type");
}
/// <summary>Adds Class Comments to a getMaxLength method</summary>
/// <param name="genMethod">the Generated Method to add the constant value comments to
/// </param>
public void decorateConstantValue(GeneratedMethod genMethod)
{
genMethod.addToDescription("Returns the constant value associated with this Data Type");
genMethod.addToComments("@return the constant value associated with this Data Type, or <code>null</code> if there is none");
}