Document the href attributes on interfaces including SVGURIReference (#…

…5112) * Document the href attributes on interfaces including SVGURIReference Follow-up to #5111. * Apply suggestions from code review Co-authored-by: Joe Medley <[email protected]> Co-authored-by: Joe Medley <[email protected]>
mdn · May 20, 2021 · 9efa08f · 9efa08f
1 parent 6a1dddd
commit 9efa08f
Show file tree

Hide file tree

Showing 11 changed files with 32 additions and 11 deletions.
diff --git a/files/en-us/web/api/svgaelement/index.html b/files/en-us/web/api/svgaelement/index.html
@@ -18,8 +18,8 @@ <h2 id="Properties">Properties</h2>
 <dl>
  <dt>{{domxref("SVGAElement.download")}}</dt>
  <dd>See {{domxref("HTMLAnchorElement.download")}}.</dd>
- <dt>{{domxref("SVGAElement.href")}}</dt>
- <dd>See {{domxref("HTMLAnchorElement.href")}}.</dd>
+ <dt>{{domxref("SVGAElement.href")}} {{ReadOnlyInline}}</dt>
+ <dd>Is an {{domxref("SVGAnimatedString")}} that reflects the {{SVGAttr("href")}} or {{SVGAttr("xlink:href")}} attribute.</dd>
  <dt>{{domxref("SVGAElement.hreflang")}}</dt>
  <dd>Is a {{domxref("DOMString")}} that reflects the <code>hreflang</code> attribute, indicating the language of the linked resource.</dd>
  <dt>{{domxref("SVGAElement.ping")}}</dt>

diff --git a/files/en-us/web/api/svganimatedpoints/index.html b/files/en-us/web/api/svganimatedpoints/index.html
@@ -14,7 +14,7 @@ <h2 id="SVG_animated_points_interface">SVG animated points interface</h2>
 
 <p>The <code>SVGAnimatedPoints</code> interface supports elements which have a {{ SVGAttr("points") }} attribute which holds a list of coordinate values and which support the ability to animate that attribute.</p>
 
-<p>Additionally, the {{ SVGAttr("points") }} attribute on the original element accessed via the XML DOM (e.g., using the <code>getAttribute()</code> method call) will reflect any changes made to the <code>SVGAnimatedPoints.points</code> attribut.</p>
+<p>Additionally, the {{ SVGAttr("points") }} attribute on the original element accessed via the XML DOM (e.g., using the <code>getAttribute()</code> method call) will reflect any changes made to the <code>SVGAnimatedPoints.points</code> attribute.</p>
 
 <h3 id="Interface_overview">Interface overview</h3>
 

diff --git a/files/en-us/web/api/svgfeimageelement/index.html b/files/en-us/web/api/svgfeimageelement/index.html
@@ -19,10 +19,12 @@ <h2 id="Properties">Properties</h2>
 <p><em>This interface also inherits properties from its parent interface, {{domxref("SVGElement")}}, and implements properties of {{domxref("SVGFilterPrimitiveStandardAttributes")}}.</em></p>
 
 <dl>
- <dt>{{domxref("SVGFEImageElement.preserveAspectRatio")}} {{ReadOnlyInline}}</dt>
- <dd>An {{domxref("SVGAnimatedPreserveAspectRatio")}} corresponding to the {{SVGAttr("preserveAspectRatio")}} attribute of the given element.</dd>
  <dt>{{domxref("SVGFEImageElement.crossOrigin")}} {{ReadOnlyInline}}</dt>
  <dd>An {{domxref("SVGAnimatedString")}} reflects the {{SVGAttr("crossorigin")}} attribute of the given element, limited to only known values.</dd>
+ <dt>{{domxref("SVGFEImageElement.href")}} {{ReadOnlyInline}}</dt>
+ <dd>An {{domxref("SVGAnimatedString")}} that reflects the {{SVGAttr("href")}} or {{SVGAttr("xlink:href")}} attribute of the given element.</dd>
+ <dt>{{domxref("SVGFEImageElement.preserveAspectRatio")}} {{ReadOnlyInline}}</dt>
+ <dd>An {{domxref("SVGAnimatedPreserveAspectRatio")}} corresponding to the {{SVGAttr("preserveAspectRatio")}} attribute of the given element.</dd>
 </dl>
 
 <h2 id="Methods">Methods</h2>

diff --git a/files/en-us/web/api/svgfilterelement/index.html b/files/en-us/web/api/svgfilterelement/index.html
@@ -17,6 +17,8 @@
 <h2 id="Properties">Properties</h2>
 
 <dl>
+ <dt>{{domxref("SVGFilterElement.href")}} {{ReadOnlyInline}}</dt>
+ <dd>An {{domxref("SVGAnimatedString")}} that corresponds to the {{SVGAttr("href")}} or {{SVGAttr("xlink:href")}} attribute of the given {{SVGElement("filter")}} element.</dd>
  <dt>{{domxref("SVGFilterElement.filterUnits")}} {{ReadOnlyInline}}</dt>
  <dd>An {{domxref("SVGAnimatedEnumeration")}} that corresponds to the {{SVGAttr("filterUnits")}} attribute of the given {{SVGElement("filter")}} element. Takes one of the constants defined in {{domxref("SVGUnitTypes")}}.</dd>
  <dt>{{domxref("SVGFilterElement.primitiveUnits")}} {{ReadOnlyInline}}</dt>

diff --git a/files/en-us/web/api/svggradientelement/index.html b/files/en-us/web/api/svggradientelement/index.html
@@ -51,12 +51,14 @@ <h2 id="Properties">Properties</h2>
 <p><em>This interface also inherits properties from its parent, {{domxref("SVGElement")}}.</em></p>
 
 <dl>
+ <dt>{{domxref("SVGGradientElement.href")}} {{ReadOnlyInline}}</dt>
+ <dd>An {{domxref("SVGAnimatedString")}} corresponding to the {{SVGAttr("href")}} or {{SVGAttr("xlink:href")}} attribute of the given element.</dd>
  <dt>{{domxref("SVGGradientElement.gradientUnits")}} {{ReadOnlyInline}}</dt>
- <dd>Returns an {{domxref("SVGAnimatedEnumeration")}} corresponding to the {{SVGAttr("gradientUnits")}} attribute on the given element. Takes one of the constants defined in {{domxref("SVGUnitTypes")}}.</dd>
+ <dd>An {{domxref("SVGAnimatedEnumeration")}} corresponding to the {{SVGAttr("gradientUnits")}} attribute on the given element. This property takes one of the constants defined in {{domxref("SVGUnitTypes")}}.</dd>
  <dt>{{domxref("SVGGradientElement.gradientTransform")}} {{ReadOnlyInline}}</dt>
- <dd>Returns an {{domxref("SVGAnimatedTransformList")}} corresponding to attribute {{SVGAttr("gradientTransform")}} on the given element.</dd>
+ <dd>An {{domxref("SVGAnimatedTransformList")}} corresponding to the {{SVGAttr("gradientTransform")}} attribute on the given element.</dd>
  <dt>{{domxref("SVGGradientElement.spreadMethod")}} {{ReadOnlyInline}}</dt>
- <dd>Returns an {{domxref("SVGAnimatedEnumeration")}} corresponding to attribute {{SVGAttr("spreadMethod")}} on the given element. One of the spread method types defined on this interface.</dd>
+ <dd>An {{domxref("SVGAnimatedEnumeration")}} corresponding to the {{SVGAttr("spreadMethod")}} attribute on the given element. One of the spread method types defined on this interface.</dd>
 </dl>
 
 <h2 id="Methods">Methods</h2>

diff --git a/files/en-us/web/api/svgimageelement/index.html b/files/en-us/web/api/svgimageelement/index.html
@@ -22,10 +22,12 @@ <h2 id="Properties">Properties</h2>
 <p><em>This interface also inherits properties from its parent, {{domxref("SVGGraphicsElement")}}.</em></p>
 
 <dl>
+	<dt>{{domxref("SVGImageElement.href")}} {{ReadOnlyInline}}</dt>
+	<dd>An {{domxref("SVGAnimatedString")}} corresponding to the {{SVGAttr("href")}} or {{SVGAttr("xlink:href")}} attribute of the given {{SVGElement("image")}} element.</dd>
 	<dt>{{domxref("SVGImageElement.crossOrigin")}}</dt>
 	<dd>A {{domxref("DOMString")}} corresponding to the {{SVGAttr("crossorigin")}} attribute of the given {{SVGElement("image")}} element.</dd>
 	<dt>{{domxref("SVGImageElement.decoding")}}</dt>
-	<dd>Returns a {{domxref("DOMString")}} representing a hint given to the browser on how it should decode the image.</dd>
+	<dd>A {{domxref("DOMString")}} representing a hint given to the browser on how it should decode the image.</dd>
 	<dt>{{domxref("SVGImageElement.height")}} {{ReadOnlyInline}}</dt>
 	<dd>An {{domxref("SVGAnimatedLength")}} corresponding to the {{SVGAttr("height")}} attribute of the given {{SVGElement("image")}} element.</dd>
 	<dt>{{domxref("SVGImageElement.preserveAspectRatio")}} {{ReadOnlyInline}}</dt>

diff --git a/files/en-us/web/api/svgmpathelement/index.html b/files/en-us/web/api/svgmpathelement/index.html
@@ -16,7 +16,12 @@
 
 <h2 id="Properties">Properties</h2>
 
-<p><em>This interface doesn't implement any specific properties, but inherits properties from its parent interface, {{domxref("SVGElement")}}.</em></p>
+<p><em>This interface also inherits properties from its parent, {{domxref("SVGElement")}}.</em></p>
+
+<dl>
+  <dt>{{domxref("SVGMPathElement.href")}} {{ReadOnlyInline}}</dt>
+  <dd>An {{domxref("SVGAnimatedString")}} that corresponds to the {{SVGAttr("href")}} or {{SVGAttr("xlink:href")}} attribute of the given {{SVGElement("mpath")}} element.</dd>
+</dl>
 
 <h2 id="Methods">Methods</h2>
 

diff --git a/files/en-us/web/api/svgpatternelement/index.html b/files/en-us/web/api/svgpatternelement/index.html
@@ -19,6 +19,8 @@ <h2 id="Properties">Properties</h2>
 <p><em>This interface also inherits properties from its parent, {{domxref("SVGElement")}} and implements the ones from {{domxref("SVGFitToViewBox")}}.</em></p>
 
 <dl>
+ <dt>{{domxref("SVGPatternElement.href")}} {{ReadOnlyInline}}</dt>
+ <dd>An {{domxref("SVGAnimatedString")}} corresponding to the {{SVGAttr("href")}} or {{SVGAttr("xlink:href")}} attribute of the given {{SVGElement("pattern")}} element.</dd>
  <dt>{{domxref("SVGPatternElement.patternUnits")}} {{ReadOnlyInline}}</dt>
  <dd>An {{domxref("SVGAnimatedEnumeration")}} corresponding to the {{SVGAttr("patternUnits")}} attribute of the given {{SVGElement("pattern")}} element. Takes one of the constants defined in {{domxref("SVGUnitTypes")}}.</dd>
  <dt>{{domxref("SVGPatternElement.patternContentUnits")}} {{ReadOnlyInline}}</dt>

diff --git a/files/en-us/web/api/svgscriptelement/index.html b/files/en-us/web/api/svgscriptelement/index.html
@@ -17,8 +17,10 @@
 <h2 id="Properties">Properties</h2>
 
 <dl>
+ <dt>{{domxref("SVGScriptElement.href")}} {{ReadOnlyInline}}</dt>
+ <dd>An {{domxref("SVGAnimatedString")}} corresponding to the {{SVGAttr("href")}} or {{SVGAttr("xlink:href")}} attribute of the given {{SVGElement("script")}} element.</dd>
  <dt>{{domxref("SVGScriptElement.type")}} {{ReadOnlyInline}}</dt>
- <dd>A {{domxref("DOMString")}} corresponding to the {{SVGAttr("type")}} attribute of the given {{SVGElement("script")}} element. A {{domxref("DOMException")}} is raised with the code <code>NO_MODIFICATION_ALLOWED_ERR</code> on an attempt to change the value of a read only attribut.</dd>
+ <dd>A {{domxref("DOMString")}} corresponding to the {{SVGAttr("type")}} attribute of the given {{SVGElement("script")}} element. A {{domxref("DOMException")}} is raised with the code <code>NO_MODIFICATION_ALLOWED_ERR</code> on an attempt to change the value of a read only attribute.</dd>
  <dt>{{domxref("SVGScriptElement.crossOrigin")}} {{ReadOnlyInline}}</dt>
  <dd>A {{domxref("DOMString")}} corresponding to the {{SVGAttr("crossorigin")}} attribute of the given {{SVGElement("script")}} element.</dd>
 </dl>

diff --git a/files/en-us/web/api/svgtextpathelement/index.html b/files/en-us/web/api/svgtextpathelement/index.html
@@ -75,6 +75,8 @@ <h2 id="Properties">Properties</h2>
 <p><em>This interface also inherits properties from its parent interface, {{domxref("SVGTextContentElement")}}.</em></p>
 
 <dl>
+ <dt>{{domxref("SVGTextPathElement.href")}} {{ReadOnlyInline}}</dt>
+ <dd>An {{domxref("SVGAnimatedString")}} corresponding to the {{SVGAttr("href")}} or {{SVGAttr("xlink:href")}} attribute of the given element.</dd>
  <dt>{{domxref("SVGTextPathElement.startOffset")}} {{ReadOnlyInline}}</dt>
  <dd>An {{domxref("SVGAnimatedLength")}} corresponding to the X component of the {{SVGAttr("startOffset")}} attribute of the given element.</dd>
  <dt>{{domxref("SVGTextPathElement.method")}} {{ReadOnlyInline}}</dt>

diff --git a/files/en-us/web/api/svguseelement/index.html b/files/en-us/web/api/svguseelement/index.html
@@ -21,6 +21,8 @@ <h2 id="Properties">Properties</h2>
 <p><em>This interface also inherits properties from its parent interface, {{domxref("SVGGraphicsElement")}}.</em></p>
 
 <dl>
+ <dt>{{domxref("SVGUseElement.href")}} {{ReadOnlyInline}}</dt>
+ <dd>An {{domxref("SVGAnimatedString")}} corresponding to the {{SVGAttr("href")}} or {{SVGAttr("xlink:href")}} attribute of the given element.</dd>
  <dt>{{domxref("SVGUseElement.x")}} {{ReadOnlyInline}}</dt>
  <dd>An {{domxref("SVGAnimatedLength")}} corresponding to the {{SVGAttr("x")}} attribute of the given element.</dd>
  <dt>{{domxref("SVGUseElement.y")}} {{ReadOnlyInline}}</dt>