GRAILS-6598 fixed javadoc, added line breaks and escaped < and >

Author: burtbeckwith

src/java/org/codehaus/groovy/grails/plugins/web/taglib/ApplicationTagLib.groovy

@@ -104,7 +104,7 @@ class ApplicationTagLib implements ApplicationContextAware, InitializingBean {
     }
 
     /**
-     * Get the declared URL of the server from config, or guess at localhost for non-production
+     * Get the declared URL of the server from config, or guess at localhost for non-production.
      */
     String makeServerURL() {
         def u = ConfigurationHolder.config?.grails?.serverURL
@@ -118,7 +118,7 @@ class ApplicationTagLib implements ApplicationContextAware, InitializingBean {
     }
 
     /**
-     * Check for "absolute" attribute and render server URL if available from Config or deducible in non-production
+     * Check for "absolute" attribute and render server URL if available from Config or deducible in non-production.
      */
     private handleAbsolute(attrs) {
         def base = attrs.remove('base')
@@ -140,25 +140,25 @@ class ApplicationTagLib implements ApplicationContextAware, InitializingBean {
     }
 
     /**
-     * Creates a link to a resource, generally used as a method rather than a tag.
+     * Creates a link to a resource, generally used as a method rather than a tag.<br/>
      *
-     * eg. <link type="text/css" href="${createLinkTo(dir:'css',file:'main.css')}" />
+     * eg. &lt;link type="text/css" href="${createLinkTo(dir:'css',file:'main.css')}" /&gt;
      */
     def createLinkTo = { attrs ->
         GrailsUtil.deprecated "Tag [createLinkTo] is deprecated please use [resource] instead"
         out << resource(attrs)
     }
 
     /**
-     * Creates a link to a resource, generally used as a method rather than a tag.
+     * Creates a link to a resource, generally used as a method rather than a tag.<br/>
      *
-     * eg. <link type="text/css" href="${resource(dir:'css',file:'main.css')}" />
+     * eg. &lt;link type="text/css" href="${resource(dir:'css',file:'main.css')}" /&gt;
      * 
      * @attr base Sets the prefix to be added to the link target address, typically an absolute server URL. This overrides the behaviour of the absolute property, if both are specified.x≈
      * @attr contextPath the context path to use (relative to the application context path). Defaults to "" or path to the plugin for a plugin view or template.
      * @attr dir the name of the directory within the grails app to link to
      * @attr file the name of the file within the grails app to link to
-     * @attr absolute If set to "true" will prefix the link target address with the value of the grails.serverURL property from Config, or http://localhost:<port> if no value in Config and not running in production.
+     * @attr absolute If set to "true" will prefix the link target address with the value of the grails.serverURL property from Config, or http://localhost:&lt;port&gt; if no value in Config and not running in production.
      * @attr plugin The plugin to look for the resource in
      */
     def resource = { attrs ->
@@ -195,17 +195,17 @@ class ApplicationTagLib implements ApplicationContextAware, InitializingBean {
     }
 
     /**
-     * General linking to controllers, actions etc. Examples:
+     * General linking to controllers, actions etc. Examples:<br/>
      *
-     * <g:link action="myaction">link 1</gr:link>
-     * <g:link controller="myctrl" action="myaction">link 2</gr:link>
+     * &lt;g:link action="myaction"&gt;link 1&lt;/gr:link&gt;<br/>
+     * &lt;g:link controller="myctrl" action="myaction"&gt;link 2&lt;/gr:link&gt;<br/>
      *
      * @attr controller The name of the controller to use in the link, if not specified the current controller will be linked
      * @attr action The name of the action to use in the link, if not specified the default action will be linked
      * @attr uri relative URI
      * @attr url A map containing the action,controller,id etc.
      * @attr base Sets the prefix to be added to the link target address, typically an absolute server URL. This overrides the behaviour of the absolute property, if both are specified.
-     * @attr absolute If set to "true" will prefix the link target address with the value of the grails.serverURL property from Config, or http://localhost:<port> if no value in Config and not running in production.
+     * @attr absolute If set to "true" will prefix the link target address with the value of the grails.serverURL property from Config, or http://localhost:&lt;port&gt; if no value in Config and not running in production.
      * @attr id The id to use in the link
      * @attr fragment The link fragment (often called anchor tag) to use
      * @attr params A map containing URL query parameters
@@ -249,16 +249,16 @@ class ApplicationTagLib implements ApplicationContextAware, InitializingBean {
     /**
      * Creates a grails application link from a set of attributes. This
      * link can then be included in links, ajax calls etc. Generally used as a method call
-     * rather than a tag eg.
+     * rather than a tag eg.<br/>
      *
-     *  <a href="${createLink(action:'list')}">List</a>
+     * &lt;a href="${createLink(action:'list')}"&gt;List&lt;/a&gt;
      * 
      * @attr controller The name of the controller to use in the link, if not specified the current controller will be linked
      * @attr action The name of the action to use in the link, if not specified the default action will be linked
      * @attr uri relative URI
      * @attr url A map containing the action,controller,id etc.
      * @attr base Sets the prefix to be added to the link target address, typically an absolute server URL. This overrides the behaviour of the absolute property, if both are specified.
-     * @attr absolute If set to "true" will prefix the link target address with the value of the grails.serverURL property from Config, or http://localhost:<port> if no value in Config and not running in production.
+     * @attr absolute If set to "true" will prefix the link target address with the value of the grails.serverURL property from Config, or http://localhost:&lt;port&gt; if no value in Config and not running in production.
      * @attr id The id to use in the link
      * @attr fragment The link fragment (often called anchor tag) to use
      * @attr params A map containing URL query parameters
@@ -336,12 +336,12 @@ class ApplicationTagLib implements ApplicationContextAware, InitializingBean {
     }
 
     /**
-     * Helper method for creating tags called like:
-     *
-     * withTag(name:'script',attrs:[type:'text/javascript']) {
-     *
-     * }
-     *
+     * Helper method for creating tags called like:<br/>
+     * <pre>
+     *    withTag(name:'script',attrs:[type:'text/javascript']) {
+     *    ...
+     *    }
+     * </pre>
      * @attr name REQUIRED the tag name
      * @attr attrs tag attributes
      */

src/java/org/codehaus/groovy/grails/plugins/web/taglib/CountryTagLib.groovy

@@ -287,7 +287,7 @@ class CountryTagLib {
      * @attr id the DOM element id - uses the name attribute if not specified
      * @attr keys A list of values to be used for the value attribute of each "option" element.
      * @attr optionKey By default value attribute of each <option> element will be the result of a "toString()" call on each element. Setting this allows the value to be a bean property of each element in the list.
-     * @attr optionValue By default the body of each <option> element will be the result of a "toString()" call on each element in the "from" attribute list. Setting this allows the value to be a bean property of each element in the list.
+     * @attr optionValue By default the body of each &lt;option&gt; element will be the result of a "toString()" call on each element in the "from" attribute list. Setting this allows the value to be a bean property of each element in the list.
      * @attr multiple boolean value indicating whether the select a multi-select (automatically true if the value is a collection, defaults to false - single-select)
      * @attr noSelection A single-entry map detailing the key and value to use for the "no selection made" choice in the select box. If there is no current selection this will be shown as it is first in the list, and if submitted with this selected, the key that you provide will be submitted. Typically this will be blank - but you can also use 'null' in the case that you're passing the ID of an object
      * @attr disabled boolean value indicating whether the select is disabled or enabled (defaults to false - enabled)
@@ -306,7 +306,7 @@ class CountryTagLib {
     }
 
     /**
-     * Take a country code and output the country name, from the internal data
+     * Take a country code and output the country name, from the internal data.<br/>
      * Note: to use message bundle to resolve name, use g:message tag
      * @attr code REQUIRED the ISO3166_3 country code
      */

src/java/org/codehaus/groovy/grails/plugins/web/taglib/FormTagLib.groovy

@@ -173,7 +173,7 @@ class FormTagLib {
     }
 
     /**
-     * A general tag for creating textareas
+     * A general tag for creating textareas.
      *
      * @attr name REQUIRED the name of the textarea
      * @attr value  the text of the textarea; if not specified renders the body as the text
@@ -223,7 +223,7 @@ class FormTagLib {
     }
 
     /**
-     * Dump out attributes in HTML compliant fashion
+     * Dump out attributes in HTML compliant fashion.
      */
     void outputAttributes(attrs) {
         attrs.remove('tagName') // Just in case one is left
@@ -234,7 +234,7 @@ class FormTagLib {
     }
 
     /**
-     * Same as <g:form>, except sets the relevant enctype for a file upload form.
+     * Same as &lt;g:form&gt;, except sets the relevant enctype for a file upload form.
      *
      * @attr action the name of the action to use in the link, if not specified the default action will be linked
      * @attr controller the name of the controller to use in the link, if not specified the current controller will be linked
@@ -250,10 +250,10 @@ class FormTagLib {
     }
 
     /**
-     * General linking to controllers, actions etc. Examples:
+     * General linking to controllers, actions etc. Examples:<br/>
      *
-     * <g:form action="myaction">...</gr:form>
-     * <g:form controller="myctrl" action="myaction">...</gr:form>
+     * &lt;g:form action="myaction"&gt;...&lt;/gr:form&gt;<br/>
+     * &lt;g:form controller="myctrl" action="myaction"&gt;...&lt;/gr:form&gt;<br/>
      * 
      * @attr action the name of the action to use in the link, if not specified the default action will be linked
      * @attr controller the name of the controller to use in the link, if not specified the current controller will be linked
@@ -313,13 +313,13 @@ class FormTagLib {
     }
 
     /**
-     * Creates a submit button that submits to an action in the controller specified by the form action
+     * Creates a submit button that submits to an action in the controller specified by the form action.<br/>
      * The name of the action attribute is translated into the action name, for example "Edit" becomes
-     * "_action_edit" or "List People" becomes "_action_listPeople"
-     * If the action attribute is not specified, the value attribute will be used as part of the action name
+     * "_action_edit" or "List People" becomes "_action_listPeople".<br/>
+     * If the action attribute is not specified, the value attribute will be used as part of the action name.
      *
-     * <g:actionSubmit value="Edit" />
-     * <g:actionSubmit action="Edit" value="Some label for editing" />
+     * &lt;g:actionSubmit value="Edit" /&gt;<br/>
+     * &lt;g:actionSubmit action="Edit" value="Some label for editing" /&gt;<br/>
      *
      * @attr value REQUIRED The title of the button and name of action when not explicitly defined.
      * @attr action The name of the action to be executed, otherwise it is derived from the value.
@@ -345,12 +345,12 @@ class FormTagLib {
     }
 
     /**
-     * Creates a an image submit button that submits to an action in the controller specified by the form action
+     * Creates a an image submit button that submits to an action in the controller specified by the form action.
      * The name of the action attribute is translated into the action name, for example "Edit" becomes
-     * "_action_edit" or "List People" becomes "_action_listPeople"
-     * If the action attribute is not specified, the value attribute will be used as part of the action name
+     * "_action_edit" or "List People" becomes "_action_listPeople".<br/>
+     * If the action attribute is not specified, the value attribute will be used as part of the action name.<br/>
      *
-     * <g:actionSubmitImage src="/images/submitButton.gif" action="Edit" />
+     * &lt;g:actionSubmitImage src="/images/submitButton.gif" action="Edit" /&gt;
      *
      * @attr value REQUIRED The title of the button and name of action when not explicitly defined.
      * @attr action The name of the action to be executed, otherwise it is derived from the value.
@@ -383,9 +383,9 @@ class FormTagLib {
     }
 
     /**
-     * A simple date picker that renders a date as selects
-     * eg. <g:datePicker name="myDate" value="${new Date()}" />
-     * 
+     * A simple date picker that renders a date as selects.<br/>
+     * e.g. &lt;g:datePicker name="myDate" value="${new Date()}" /&gt;
+     *
      * @attr name REQUIRED The name of the date picker field set
      * @attr value The current value of the date picker; defaults to now if not specified
      * @attr precision The desired granularity of the date to be rendered
@@ -572,8 +572,8 @@ class FormTagLib {
     }
 
     /**
-     * A helper tag for creating TimeZone selects
-     * eg. <g:timeZoneSelect name="myTimeZone" value="${tz}" />
+     * A helper tag for creating TimeZone selects.<br/>
+     * eg. &lt;g:timeZoneSelect name="myTimeZone" value="${tz}" /&gt;
      * 
      * @attr name REQUIRED The name of the select
      * @attr value An instance of java.util.TimeZone. Defaults to the time zone for the current Locale if not specified
@@ -601,9 +601,9 @@ class FormTagLib {
     }
 
     /**
-     *  A helper tag for creating locale selects
+     * A helper tag for creating locale selects.<br/>
      *
-     * eg. <g:localeSelect name="myLocale" value="${locale}" />
+     * eg. &lt;g:localeSelect name="myLocale" value="${locale}" /&gt;
      *
      * @attr name REQUIRED The name of the select
      * @attr value The set locale, defaults to the current request locale if not specified
@@ -621,9 +621,10 @@ class FormTagLib {
     }
 
     /**
-     * A helper tag for creating currency selects
+     * A helper tag for creating currency selects.<br/>
+     *
+     * eg. &lt;g:currencySelect name="myCurrency" value="${currency}" /&gt;
      *
-     * eg. <g:currencySelect name="myCurrency" value="${currency}" />
      * @attr from The currency symbols to select from, defaults to the major ones if not specified
      * @attr value The currency value as the currency code. Defaults to the currency for the current Locale if not specified
      */
@@ -643,18 +644,18 @@ class FormTagLib {
     }
 
     /**
-     * A helper tag for creating HTML selects.
+     * A helper tag for creating HTML selects.<br/>
      *
-     * Examples:
-     * <g:select name="user.age" from="${18..65}" value="${age}" />
-     * <g:select name="user.company.id" from="${Company.list()}" value="${user?.company.id}" optionKey="id" />
+     * Examples:<br/>
+     * &lt;g:select name="user.age" from="${18..65}" value="${age}" /&gt;<br/>
+     * &lt;g:select name="user.company.id" from="${Company.list()}" value="${user?.company.id}" optionKey="id" /&gt;<br/>
      * 
      * @attr name the select name
      * @attr id the DOM element id - uses the name attribute if not specified
      * @attr from The list or range to select from
      * @attr keys A list of values to be used for the value attribute of each "option" element.
-     * @attr optionKey By default value attribute of each <option> element will be the result of a "toString()" call on each element. Setting this allows the value to be a bean property of each element in the list.
-     * @attr optionValue By default the body of each <option> element will be the result of a "toString()" call on each element in the "from" attribute list. Setting this allows the value to be a bean property of each element in the list.
+     * @attr optionKey By default value attribute of each &lt;option&gt; element will be the result of a "toString()" call on each element. Setting this allows the value to be a bean property of each element in the list.
+     * @attr optionValue By default the body of each &lt;option&gt; element will be the result of a "toString()" call on each element in the "from" attribute list. Setting this allows the value to be a bean property of each element in the list.
      * @attr value The current selected value that evaluates equals() to true for one of the elements in the from list.
      * @attr multiple boolean value indicating whether the select a multi-select (automatically true if the value is a collection, defaults to false - single-select)
      * @attr valueMessagePrefix By default the value "option" element will be the result of a "toString()" call on each element in the "from" attribute list. Setting this allows the value to be resolved from the I18n messages. The valueMessagePrefix will be suffixed with a dot ('.') and then the value attribute of the option to resolve the message. If the message could not be resolved, the value is presented.
@@ -829,7 +830,7 @@ class FormTagLib {
     }
 
     /**
-     * A helper tag for creating radio button groups
+     * A helper tag for creating radio button groups.
      * 
      * @attr name REQUIRED The name of the group
      * @attr values REQUIRED The list values for the radio buttons

src/java/org/codehaus/groovy/grails/plugins/web/taglib/FormatTagLib.groovy

@@ -29,7 +29,7 @@ import org.springframework.web.servlet.support.RequestContextUtils as RCU
 
 /**
  * The base application tag library for Grails many of which take inspiration from Rails helpers (thanks guys! :)
- * This tag library tends to get extended by others as tags within here can be re-used in said libraries
+ * This tag library tends to get extended by others as tags within here can be re-used in said libraries.
  *
  * @author Jason Rudolph
  * @author Lari Hotari
@@ -64,12 +64,12 @@ class FormatTagLib {
     /**
      * Outputs the given boolean as the specified text label. If the
      * <code>true</code> and <code>false</code> option are not given,
-     * then the boolean is output using the default label.
+     * then the boolean is output using the default label.<br/>
      *
-     * Examples:
+     * Examples:<br/>
      *
-     * <g:formatBoolean boolean="${myBoolean}" />
-     * <g:formatBoolean boolean="${myBoolean}" true="True!" false="False!" />
+     * &lt;g:formatBoolean boolean="${myBoolean}" /&gt;<br/>
+     * &lt;g:formatBoolean boolean="${myBoolean}" true="True!" false="False!" /&gt;<br/>
      *
      * @attr boolean REQUIRED the boolean to output
      * @attr true text label for boolean true value
@@ -99,12 +99,12 @@ class FormatTagLib {
     }
 
     /**
-     * Outputs the given <code>Date</code> object in the specified format.  If
+     * Outputs the given <code>Date</code> object in the specified format. If
      * the <code>date</code> is not given, then the current date/time is used.
      * If the <code>format</code> option is not given, then the date is output
-     * using the default format.
+     * using the default format.<br/>
      *
-     * e.g., <g:formatDate date="${myDate}" format="yyyy-MM-dd HH:mm" />
+     * e.g., &lt;g:formatDate date="${myDate}" format="yyyy-MM-dd HH:mm" /&gt;<br/>
      *
      * @see java.text.SimpleDateFormat
      *
@@ -197,9 +197,9 @@ class FormatTagLib {
     /**
      * Outputs the given number in the specified format.  If the
      * <code>format</code> option is not given, then the number is output
-     * using the default format.
+     * using the default format.<br/>
      *
-     * e.g., <g:formatNumber number="${myNumber}" format="###,##0" />
+     * e.g., &lt;g:formatNumber number="${myNumber}" format="###,##0" /&gt;
      *
      * @see java.text.DecimalFormat
      *