/** * Generate the Javadoc comment header for a type. * * @param indent level for the comment. * @param typeToken for the type. * @return a string representation of the Javadoc comment. */ public static String generateTypeJavadoc(final String indent, final Token typeToken) { final String description = typeToken.description(); if (null == description || description.isEmpty()) { return ""; } return indent + "/**\n" + indent + " * " + description + '\n' + indent + " */\n"; }
/** * Generate the Javadoc comment header for group encode property. * * @param indent level for the comment. * @param propertyToken for the property name. * @param typeName for the property type. * @return a string representation of the Javadoc comment. */ public static String generateGroupEncodePropertyJavadoc( final String indent, final Token propertyToken, final String typeName) { final String description = propertyToken.description(); if (null == description || description.isEmpty()) { return ""; } return indent + "/**\n" + indent + " * " + description + "\n" + indent + " *\n" + indent + " * @param count of times the group will be encoded\n" + indent + " * @return " + typeName + " : encoder for the group\n" + indent + " */\n"; } }
/** * Generate the Javadoc comment header for flyweight property. * * @param indent level for the comment. * @param propertyToken for the property name. * @param typeName for the property type. * @return a string representation of the Javadoc comment. */ public static String generateFlyweightPropertyJavadoc( final String indent, final Token propertyToken, final String typeName) { final String description = propertyToken.description(); if (null == description || description.isEmpty()) { return ""; } return indent + "/**\n" + indent + " * " + description + '\n' + indent + " *\n" + indent + " * @return " + typeName + " : " + description + "\n" + indent + " */\n"; }
/** * Generate the Javadoc comment header for a bitset choice option encode method. * * @param indent level for the comment. * @param optionToken for the type. * @return a string representation of the Javadoc comment. */ public static String generateOptionEncodeJavadoc(final String indent, final Token optionToken) { final String description = optionToken.description(); if (null == description || description.isEmpty()) { return ""; } return indent + "/**\n" + indent + " * " + description + '\n' + indent + " *\n" + indent + " * @param value true if " + optionToken.name() + " is set or false if not\n" + indent + " */\n"; }
/** * Generate the Javadoc comment header for a bitset choice option decode method. * * @param indent level for the comment. * @param optionToken for the type. * @return a string representation of the Javadoc comment. */ public static String generateOptionDecodeJavadoc(final String indent, final Token optionToken) { final String description = optionToken.description(); if (null == description || description.isEmpty()) { return ""; } return indent + "/**\n" + indent + " * " + description + '\n' + indent + " *\n" + indent + " * @return true if " + optionToken.name() + " is set or false if not\n" + indent + " */\n"; }
tokenEncoder.putSemanticType(semanticTypeBytes, 0, semanticTypeBytes.length); final byte[] descriptionBytes = getBytes(token.description(), descriptionCharacterEncoding()); tokenEncoder.putDescription(descriptionBytes, 0, descriptionBytes.length);
/** * Generate the Javadoc comment header for a type. * * @param indent level for the comment. * @param typeToken for the type. * @return a string representation of the Javadoc comment. */ public static String generateTypeJavadoc(final String indent, final Token typeToken) { final String description = typeToken.description(); if (null == description || description.isEmpty()) { return ""; } return indent + "/**\n" + indent + " * " + description + '\n' + indent + " */\n"; }
/** * Generate the Javadoc comment header for a type. * * @param indent level for the comment. * @param typeToken for the type. * @return a string representation of the Javadoc comment. */ public static String generateTypeJavadoc(final String indent, final Token typeToken) { final String description = typeToken.description(); if (null == description || description.isEmpty()) { return ""; } return indent + "/**\n" + indent + " * " + description + '\n' + indent + " */\n"; }
/** * Generate the Javadoc comment header for flyweight property. * * @param indent level for the comment. * @param propertyToken for the property name. * @param typeName for the property type. * @return a string representation of the Javadoc comment. */ public static String generateFlyweightPropertyJavadoc( final String indent, final Token propertyToken, final String typeName) { final String description = propertyToken.description(); if (null == description || description.isEmpty()) { return ""; } return indent + "/**\n" + indent + " * " + description + '\n' + indent + " *\n" + indent + " * @return " + typeName + " : " + description + "\n" + indent + " */\n"; }
/** * Generate the Javadoc comment header for flyweight property. * * @param indent level for the comment. * @param propertyToken for the property name. * @param typeName for the property type. * @return a string representation of the Javadoc comment. */ public static String generateFlyweightPropertyJavadoc( final String indent, final Token propertyToken, final String typeName) { final String description = propertyToken.description(); if (null == description || description.isEmpty()) { return ""; } return indent + "/**\n" + indent + " * " + description + '\n' + indent + " *\n" + indent + " * @return " + typeName + " : " + description + "\n" + indent + " */\n"; }
/** * Generate the Javadoc comment header for group encode property. * * @param indent level for the comment. * @param propertyToken for the property name. * @param typeName for the property type. * @return a string representation of the Javadoc comment. */ public static String generateGroupEncodePropertyJavadoc( final String indent, final Token propertyToken, final String typeName) { final String description = propertyToken.description(); if (null == description || description.isEmpty()) { return ""; } return indent + "/**\n" + indent + " * " + description + "\n" + indent + " *\n" + indent + " * @param count of times the group will be encoded\n" + indent + " * @return " + typeName + " : encoder for the group\n" + indent + " */\n"; } }
/** * Generate the Javadoc comment header for group encode property. * * @param indent level for the comment. * @param propertyToken for the property name. * @param typeName for the property type. * @return a string representation of the Javadoc comment. */ public static String generateGroupEncodePropertyJavadoc( final String indent, final Token propertyToken, final String typeName) { final String description = propertyToken.description(); if (null == description || description.isEmpty()) { return ""; } return indent + "/**\n" + indent + " * " + description + "\n" + indent + " *\n" + indent + " * @param count of times the group will be encoded\n" + indent + " * @return " + typeName + " : encoder for the group\n" + indent + " */\n"; } }
/** * Generate the Javadoc comment header for a bitset choice option encode method. * * @param indent level for the comment. * @param optionToken for the type. * @return a string representation of the Javadoc comment. */ public static String generateOptionEncodeJavadoc(final String indent, final Token optionToken) { final String description = optionToken.description(); if (null == description || description.isEmpty()) { return ""; } return indent + "/**\n" + indent + " * " + description + '\n' + indent + " *\n" + indent + " * @param value true if " + optionToken.name() + " is set or false if not\n" + indent + " */\n"; }
/** * Generate the Javadoc comment header for a bitset choice option decode method. * * @param indent level for the comment. * @param optionToken for the type. * @return a string representation of the Javadoc comment. */ public static String generateOptionDecodeJavadoc(final String indent, final Token optionToken) { final String description = optionToken.description(); if (null == description || description.isEmpty()) { return ""; } return indent + "/**\n" + indent + " * " + description + '\n' + indent + " *\n" + indent + " * @return true if " + optionToken.name() + " is set or false if not\n" + indent + " */\n"; }
/** * Generate the Javadoc comment header for a bitset choice option decode method. * * @param indent level for the comment. * @param optionToken for the type. * @return a string representation of the Javadoc comment. */ public static String generateOptionDecodeJavadoc(final String indent, final Token optionToken) { final String description = optionToken.description(); if (null == description || description.isEmpty()) { return ""; } return indent + "/**\n" + indent + " * " + description + '\n' + indent + " *\n" + indent + " * @return true if " + optionToken.name() + " is set or false if not\n" + indent + " */\n"; }
/** * Generate the Javadoc comment header for a bitset choice option encode method. * * @param indent level for the comment. * @param optionToken for the type. * @return a string representation of the Javadoc comment. */ public static String generateOptionEncodeJavadoc(final String indent, final Token optionToken) { final String description = optionToken.description(); if (null == description || description.isEmpty()) { return ""; } return indent + "/**\n" + indent + " * " + description + '\n' + indent + " *\n" + indent + " * @param value true if " + optionToken.name() + " is set or false if not\n" + indent + " */\n"; }
tokenEncoder.putSemanticType(semanticTypeBytes, 0, semanticTypeBytes.length); final byte[] descriptionBytes = getBytes(token.description(), descriptionCharacterEncoding()); tokenEncoder.putDescription(descriptionBytes, 0, descriptionBytes.length);
tokenEncoder.putSemanticType(semanticTypeBytes, 0, semanticTypeBytes.length); final byte[] descriptionBytes = getBytes(token.description(), descriptionCharacterEncoding()); tokenEncoder.putDescription(descriptionBytes, 0, descriptionBytes.length);