Merge pull request #24 from BorderTech/feature/api-javadoc-links

Update javadoc with api links and adjust some of the element categories

webfriends-api/src/main/java/com/github/bordertech/webfriends/api/common/attribute/WindowTarget.java

@@ -2,6 +2,8 @@
 
 /**
  * Target window type.
+ *
+ * @see <a href="https://html.spec.whatwg.org/#navigable-target-names">HTML Spec</a>
  */
 public final class WindowTarget {
 

webfriends-api/src/main/java/com/github/bordertech/webfriends/api/common/capability/Autocapitalizable.java

@@ -6,6 +6,9 @@
 
 /**
  * Element that can be autocapitalized.
+ *
+ * @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form#autocapitalize">Web Docs</a>
+ * @see <a href="https://html.spec.whatwg.org/#autocapitalization">HTML Spec</a>
  */
 public interface Autocapitalizable extends Element {
 

webfriends-api/src/main/java/com/github/bordertech/webfriends/api/common/capability/Dimensionable.java

@@ -3,7 +3,9 @@
 import com.github.bordertech.webfriends.api.element.Element;
 
 /**
- * Element with dimensions.
+ * Element with dimensions (ie height and width).
+ *
+ * @see <a href="https://html.spec.whatwg.org/#dimension-attributes">HTML Spec</a>
  */
 public interface Dimensionable extends Element {
 

webfriends-api/src/main/java/com/github/bordertech/webfriends/api/common/capability/Focusable.java

@@ -4,7 +4,12 @@
 import com.github.bordertech.webfriends.api.element.Element;
 
 /**
- * Element that can be focused.
+ * Element that can be focused (ie tabindex and accesskey).
+ *
+ * @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex">Web Docs tabindex</a>
+ * @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/accesskey">Web Docs accesskey</a>
+ * @see <a href="https://html.spec.whatwg.org/#the-tabindex-attribute">HTML Spec tabindex</a>
+ * @see <a href="https://html.spec.whatwg.org/#the-accesskey-attribute">HTML Spec accesskey</a>
  */
 public interface Focusable extends Element {
 

webfriends-api/src/main/java/com/github/bordertech/webfriends/api/common/capability/SpellCheckable.java

@@ -4,6 +4,9 @@
 
 /**
  * Element that can be spell checked.
+ *
+ * @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/spellcheck">Web Docs</a>
+ * @see <a href="https://html.spec.whatwg.org/#spelling-and-grammar-checking">HTML Spec</a>
  */
 public interface SpellCheckable extends Element {
 

webfriends-api/src/main/java/com/github/bordertech/webfriends/api/common/category/Category.java

@@ -4,6 +4,9 @@
 
 /**
  * Every element is a member of one or more content categories.
+ *
+ * @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Content_categories">Web Docs</a>
+ * @see <a href="https://html.spec.whatwg.org/#kinds-of-content">HTML Spec</a>
  */
 public interface Category extends Element {
 }

webfriends-api/src/main/java/com/github/bordertech/webfriends/api/common/category/EmbeddedContent.java

@@ -2,6 +2,9 @@
 
 /**
  * Embedded content imports another resource into the document.
+ *
+ * @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Content_categories#embedded_content">Web Docs</a>
+ * @see <a href="https://html.spec.whatwg.org/#embedded-content-category">HTML Spec</a>
  */
 public interface EmbeddedContent extends PhrasingContent {
 }

webfriends-api/src/main/java/com/github/bordertech/webfriends/api/common/category/FlowContent.java

@@ -5,6 +5,9 @@
  * <p>
  * Most elements that are used in the body of documents and applications are categorized as flow content.
  * </p>
+ *
+ * @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Content_categories#flow_content">Web Docs</a>
+ * @see <a href="https://html.spec.whatwg.org/#flow-content">HTML Spec</a>
  */
 public interface FlowContent extends Category {
 }

webfriends-api/src/main/java/com/github/bordertech/webfriends/api/common/category/HeadingContent.java

@@ -2,6 +2,9 @@
 
 /**
  * Element that defines the header details of a section.
+ *
+ * @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Content_categories#heading_content">Web Docs</a>
+ * @see <a href="https://html.spec.whatwg.org/#heading-content">HTML Spec</a>
  */
 public interface HeadingContent extends FlowContent {
 

webfriends-api/src/main/java/com/github/bordertech/webfriends/api/common/category/InteractiveContent.java

@@ -2,6 +2,9 @@
 
 /**
  * Interactive content is specifically intended for user interaction.
+ *
+ * @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Content_categories#interactive_content">Web Docs</a>
+ * @see <a href="https://html.spec.whatwg.org/#interactive-content">HTML Spec</a>
  */
 public interface InteractiveContent extends FlowContent {
 }

webfriends-api/src/main/java/com/github/bordertech/webfriends/api/common/category/MetadataContent.java

@@ -3,6 +3,9 @@
 /**
  * Metadata content modifies the presentation or the behavior of the rest of the document, sets up links to other documents, or conveys other out of
  * band information.
+ *
+ * @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Content_categories#metadata_content">Web Docs</a>
+ * @see <a href="https://html.spec.whatwg.org/#metadata-content">HTML Spec</a>
  */
 public interface MetadataContent extends Category {
 }

webfriends-api/src/main/java/com/github/bordertech/webfriends/api/common/category/PalpableContent.java

@@ -6,6 +6,9 @@
  * Content is palpable when it's neither empty or hidden; it is content that is rendered and is substantive. Elements whose model is flow content or
  * phrasing content should have at least one node which is palpable.
  * </p>
+ *
+ * @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Content_categories#palpable_content">Web Docs</a>
+ * @see <a href="https://html.spec.whatwg.org/#palpable-content">HTML Spec</a>
  */
 public interface PalpableContent extends Category {
 }

webfriends-api/src/main/java/com/github/bordertech/webfriends/api/common/category/PhrasingContent.java

@@ -6,6 +6,9 @@
  * Phrasing content is the text of the document, as well as elements that mark up that text at the intra-paragraph level. Phrasing content defines the
  * text and the mark-up it contains. Runs of phrasing content make up paragraphs.
  * </p>
+ *
+ * @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Content_categories#phrasing_content">Web Docs</a>
+ * @see <a href="https://html.spec.whatwg.org/#phrasing-content">HTML Spec</a>
  */
 public interface PhrasingContent extends FlowContent {
 }

webfriends-api/src/main/java/com/github/bordertech/webfriends/api/common/category/ScriptSupportingContent.java

@@ -1,11 +1,14 @@
 package com.github.bordertech.webfriends.api.common.category;
 
 /**
- * Element that supports scripting.
+ * Element that supports scripting such as script and template elements.
  * <p>
  * Script-supporting elements are elements which don't directly contribute to the rendered output of a document. Instead, they serve to support
  * scripts, either by containing or specifying script code directly, or by specifying data that will be used by scripts.
  * </p>
+ *
+ * @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Content_categories#script-supporting_elements">Web Docs</a>
+ * @see <a href="https://html.spec.whatwg.org/#script-supporting-elements">HTML Spec</a>
  */
 public interface ScriptSupportingContent extends Category {
 }

webfriends-api/src/main/java/com/github/bordertech/webfriends/api/common/category/SectioningContent.java

@@ -9,6 +9,9 @@
  * Sectioning content elements are always considered subsections of their nearest ancestor sectioning root or their nearest ancestor element of
  * sectioning content, whichever is nearest, regardless of what implied sections other headings may have created.
  * </p>
+ *
+ * @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Content_categories#sectioning_content">Web Docs</a>
+ * @see <a href="https://html.spec.whatwg.org/#sectioning-content">HTML Spec</a>
  */
 public interface SectioningContent extends FlowContent {
 

webfriends-api/src/main/java/com/github/bordertech/webfriends/api/common/context/ElementContext.java

@@ -2,6 +2,8 @@
 
 /**
  * Contexts in which an element can be used (ie parent).
+ *
+ * @see <a href="https://html.spec.whatwg.org/#concept-element-contexts">HTML Spec</a>
  */
 public interface ElementContext {
 

webfriends-api/src/main/java/com/github/bordertech/webfriends/api/common/form/capability/Autocompleteable.java

@@ -6,6 +6,9 @@
 
 /**
  * Form control that can be auto completed.
+ *
+ * @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete">Web Docs</a>
+ * @see <a href="https://html.spec.whatwg.org/#autofill">HTML Spec</a>
  */
 public interface Autocompleteable extends Element {
 

webfriends-api/src/main/java/com/github/bordertech/webfriends/api/common/form/capability/Autofocusable.java

@@ -4,6 +4,9 @@
 
 /**
  * Element that can be auto focused.
+ *
+ * @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus">Web Docs</a>
+ * @see <a href="https://html.spec.whatwg.org/#the-autofocus-attribute">HTML Spec</a>
  */
 public interface Autofocusable extends Element {
 

webfriends-api/src/main/java/com/github/bordertech/webfriends/api/common/form/capability/Checkable.java

@@ -4,6 +4,9 @@
 
 /**
  * Element is checkable.
+ *
+ * @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/checkbox#checked">Web Docs</a>
+ * @see <a href="https://html.spec.whatwg.org/#attr-input-checked">HTML Spec</a>
  */
 public interface Checkable extends Element {
 

webfriends-api/src/main/java/com/github/bordertech/webfriends/api/common/form/capability/Dirtyable.java

@@ -4,6 +4,8 @@
 
 /**
  * Element that can have a dirty state.
+ *
+ * @see <a href="https://html.spec.whatwg.org/#concept-fe-dirty">HTML Spec</a>
  */
 public interface Dirtyable extends Element {
 

webfriends-api/src/main/java/com/github/bordertech/webfriends/api/common/form/capability/Disableable.java

@@ -4,6 +4,9 @@
 
 /**
  * Element that can be disabled.
+ *
+ * @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/disabled">Web Docs</a>
+ * @see <a href="https://html.spec.whatwg.org/#enabling-and-disabling-form-controls:-the-disabled-attribute">HTML Spec</a>
  */
 public interface Disableable extends Element {
 

webfriends-api/src/main/java/com/github/bordertech/webfriends/api/common/form/capability/MinMaxConstrainable.java

@@ -6,6 +6,10 @@
  * Element that has min and max value constraints.
  *
  * @param <T> the element value data type
+ *
+ * @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/min">Web Docs min</a>
+ * @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/max">Web Docs max</a>
+ * @see <a href="https://html.spec.whatwg.org/#the-min-and-max-attributes">HTML Spec</a>
  */
 public interface MinMaxConstrainable<T> extends Element {
 

webfriends-api/src/main/java/com/github/bordertech/webfriends/api/common/form/capability/MinMaxLengthable.java

@@ -4,6 +4,11 @@
 
 /**
  * Element that has min and max lengths.
+ *
+ * @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/maxlength">Web Docs maxlength</a>
+ * @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/minlength">Web Docs minlength</a>
+ * @see <a href="https://html.spec.whatwg.org/#limiting-user-input-length:-the-maxlength-attribute">HTML Spec maxlength</a>
+ * @see <a href="https://html.spec.whatwg.org/#setting-minimum-input-length-requirements:-the-minlength-attribute">HTML Spec minlength</a>
  */
 public interface MinMaxLengthable extends Element {
 

webfriends-api/src/main/java/com/github/bordertech/webfriends/api/common/form/capability/Patternable.java

@@ -4,6 +4,9 @@
 
 /**
  * Element that allows the input to be checked against a regular expression.
+ *
+ * @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/pattern">Web Docs</a>
+ * @see <a href="https://html.spec.whatwg.org/#the-pattern-attribute">HTML Spec</a>
  */
 public interface Patternable extends Element {
 

webfriends-api/src/main/java/com/github/bordertech/webfriends/api/common/form/capability/Placeholderable.java

@@ -4,6 +4,9 @@
 
 /**
  * Element that has a place holder.
+ *
+ * @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/placeholder">Web Docs</a>
+ * @see <a href="https://html.spec.whatwg.org/#the-placeholder-attribute">HTML Spec</a>
  */
 public interface Placeholderable extends Element {
 

webfriends-api/src/main/java/com/github/bordertech/webfriends/api/common/form/capability/Readonlyable.java

@@ -4,6 +4,9 @@
 
 /**
  * Element can be readonly.
+ *
+ * @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/readonly">Web Docs</a>
+ * @see <a href="https://html.spec.whatwg.org/#attr-input-readonly">HTML Spec</a>
  */
 public interface Readonlyable extends Element {
 

webfriends-api/src/main/java/com/github/bordertech/webfriends/api/common/form/capability/Requireable.java

@@ -4,6 +4,9 @@
 
 /**
  * Element that can be required.
+ *
+ * @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/required">Web Docs</a>
+ * @see <a href="https://html.spec.whatwg.org/#the-required-attribute">HTML Spec</a>
  */
 public interface Requireable extends Element {
 

webfriends-api/src/main/java/com/github/bordertech/webfriends/api/common/form/capability/Sizeable.java

@@ -4,6 +4,9 @@
 
 /**
  * Element that can be sized.
+ *
+ * @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/size">Web Docs</a>
+ * @see <a href="https://html.spec.whatwg.org/#attr-input-size">HTML Spec</a>
  */
 public interface Sizeable extends Element {
 

webfriends-api/src/main/java/com/github/bordertech/webfriends/api/common/form/capability/Stepable.java

@@ -5,6 +5,9 @@
 
 /**
  * Element with a value that can be stepped.
+ *
+ * @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/step">Web Docs</a>
+ * @see <a href="https://html.spec.whatwg.org/#attr-input-step">HTML Spec</a>
  */
 public interface Stepable extends Element {
 

webfriends-api/src/main/java/com/github/bordertech/webfriends/api/common/form/capability/Suggestable.java

@@ -5,6 +5,9 @@
 
 /**
  * Element with a list of predefined suggestions.
+ *
+ * @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/text#list">Web Docs</a>
+ * @see <a href="https://html.spec.whatwg.org/#the-list-attribute">HTML Spec</a>
  */
 public interface Suggestable extends Element {
 

webfriends-api/src/main/java/com/github/bordertech/webfriends/api/common/form/capability/ValueMulti.java

@@ -4,6 +4,9 @@
 
 /**
  * Element that allows the user to specify more than one value.
+ *
+ * @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#value">Web Docs</a>
+ * @see <a href="https://html.spec.whatwg.org/#concept-fe-value">HTML Spec</a>
  */
 public interface ValueMulti extends ValueSingle {
 

webfriends-api/src/main/java/com/github/bordertech/webfriends/api/common/form/capability/ValueSingle.java

@@ -4,6 +4,9 @@
 
 /**
  * Input element that has a single value.
+ *
+ * @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#value">Web Docs</a>
+ * @see <a href="https://html.spec.whatwg.org/#concept-fe-value">HTML Spec</a>
  */
 public interface ValueSingle extends Element {
 

webfriends-api/src/main/java/com/github/bordertech/webfriends/api/common/form/category/AutocapitalizeInheriting.java

@@ -2,6 +2,9 @@
 
 /**
  * Element that inherits the autocapitalize attribute from their form owner.
+ *
+ * @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autocapitalize">Web Docs</a>
+ * @see <a href="https://html.spec.whatwg.org/#categories">HTML Spec</a>
  */
 public interface AutocapitalizeInheriting extends FormAssociated {
 

webfriends-api/src/main/java/com/github/bordertech/webfriends/api/common/form/category/FormAssociated.java

@@ -8,6 +8,9 @@
  * Element with content that contains elements that have a form owner, exposed by a form attribute. A form owner is either the containing form element
  * or the element whose id is specified in the form attribute
  * </p>
+ *
+ * @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Content_categories#form-associated_content">Web Docs</a>
+ * @see <a href="https://html.spec.whatwg.org/#categories">HTML Spec</a>
  */
 public interface FormAssociated extends Category {