Commit 0b5f4ccb authored by mrbean-bremen's avatar mrbean-bremen Committed by mrbean-bremen
Browse files

Added simple appveyor config that executes the unit tests

- suppress warning CS1591: Missing XML comment for publicly visible type or member
  to avoid to overflow the build log with warnings
- fixed the rest of the documentation warnings in SVG project
- ignore all failing tests for the time being
parent e93982b3
...@@ -96,9 +96,9 @@ namespace Svg ...@@ -96,9 +96,9 @@ namespace Svg
} }
/// <summary> /// <summary>
/// Renders the circle to the specified <see cref="Graphics"/> object. /// Renders the circle using the specified <see cref="ISvgRenderer"/> object.
/// </summary> /// </summary>
/// <param name="graphics">The graphics object.</param> /// <param name="renderer">The renderer object.</param>
protected override void Render(ISvgRenderer renderer) protected override void Render(ISvgRenderer renderer)
{ {
// Don't draw if there is no radius set // Don't draw if there is no radius set
......
...@@ -104,9 +104,9 @@ namespace Svg ...@@ -104,9 +104,9 @@ namespace Svg
} }
/// <summary> /// <summary>
/// Renders the <see cref="SvgElement"/> and contents to the specified <see cref="Graphics"/> object. /// Renders the <see cref="SvgElement"/> and contents using the specified <see cref="ISvgRenderer"/> object.
/// </summary> /// </summary>
/// <param name="graphics">The <see cref="Graphics"/> object to render to.</param> /// <param name="renderer">The <see cref="ISvgRenderer"/> object used for rendering.</param>
protected override void Render(ISvgRenderer renderer) protected override void Render(ISvgRenderer renderer)
{ {
if (this._radiusX.Value > 0.0f && this._radiusY.Value > 0.0f) if (this._radiusX.Value > 0.0f && this._radiusY.Value > 0.0f)
......
...@@ -111,7 +111,7 @@ namespace Svg ...@@ -111,7 +111,7 @@ namespace Svg
} }
/// <summary> /// <summary>
/// Initializes a new instance of the <see cref="SvgGraphicsElement"/> class. /// Initializes a new instance of the <see cref="SvgVisualElement"/> class.
/// </summary> /// </summary>
public SvgVisualElement() public SvgVisualElement()
{ {
......
...@@ -68,7 +68,7 @@ namespace Svg ...@@ -68,7 +68,7 @@ namespace Svg
/// <summary> /// <summary>
/// ///
/// </summary> /// </summary>
/// <param name="region"></param> /// <param name="path"></param>
/// <param name="element"></param> /// <param name="element"></param>
private void CombinePaths(GraphicsPath path, SvgElement element) private void CombinePaths(GraphicsPath path, SvgElement element)
{ {
...@@ -99,7 +99,7 @@ namespace Svg ...@@ -99,7 +99,7 @@ namespace Svg
/// <summary> /// <summary>
/// Called by the underlying <see cref="SvgElement"/> when an element has been added to the /// Called by the underlying <see cref="SvgElement"/> when an element has been added to the
/// <see cref="Children"/> collection. /// 'Children' collection.
/// </summary> /// </summary>
/// <param name="child">The <see cref="SvgElement"/> that has been added.</param> /// <param name="child">The <see cref="SvgElement"/> that has been added.</param>
/// <param name="index">An <see cref="int"/> representing the index where the element was added to the collection.</param> /// <param name="index">An <see cref="int"/> representing the index where the element was added to the collection.</param>
......
...@@ -10,7 +10,7 @@ namespace Svg ...@@ -10,7 +10,7 @@ namespace Svg
/// <remarks> /// <remarks>
/// <para>The ‘overflow’ property has the same parameter values and has the same meaning as defined in CSS2 ([CSS2], section 11.1.1); however, the following additional points apply:</para> /// <para>The ‘overflow’ property has the same parameter values and has the same meaning as defined in CSS2 ([CSS2], section 11.1.1); however, the following additional points apply:</para>
/// <para>The ‘overflow’ property applies to elements that establish new viewports (e.g., ‘svg’ elements), ‘pattern’ elements and ‘marker’ elements. For all other elements, the property has no effect (i.e., a clipping rectangle is not created).</para> /// <para>The ‘overflow’ property applies to elements that establish new viewports (e.g., ‘svg’ elements), ‘pattern’ elements and ‘marker’ elements. For all other elements, the property has no effect (i.e., a clipping rectangle is not created).</para>
/// <para>For those elements to which the ‘overflow’ property can apply, if the ‘overflow’ property has the value hidden or scroll, the effect is that a new clipping path in the shape of a rectangle is created. The result is equivalent to defining a ‘clipPath’ element whose content is a ‘rect’ element which defines the equivalent rectangle, and then specifying the <uri> of this ‘clipPath’ element on the ‘clip-path’ property for the given element.</para> /// <para>For those elements to which the ‘overflow’ property can apply, if the ‘overflow’ property has the value hidden or scroll, the effect is that a new clipping path in the shape of a rectangle is created. The result is equivalent to defining a ‘clipPath’ element whose content is a ‘rect’ element which defines the equivalent rectangle, and then specifying the 'uri' of this ‘clipPath’ element on the ‘clip-path’ property for the given element.</para>
/// <para>If the ‘overflow’ property has a value other than hidden or scroll, the property has no effect (i.e., a clipping rectangle is not created).</para> /// <para>If the ‘overflow’ property has a value other than hidden or scroll, the property has no effect (i.e., a clipping rectangle is not created).</para>
/// <para>Within SVG content, the value auto is equivalent to the value visible.</para> /// <para>Within SVG content, the value auto is equivalent to the value visible.</para>
/// <para>When an outermost svg element is embedded inline within a parent XML grammar which uses CSS layout ([CSS2], chapter 9) or XSL formatting [XSL], if the ‘overflow’ property has the value hidden or scroll, then the user agent will establish an initial clipping path equal to the bounds of the initial viewport; otherwise, the initial clipping path is set according to the clipping rules as defined in CSS2 ([CSS2], section 11.1.1).</para> /// <para>When an outermost svg element is embedded inline within a parent XML grammar which uses CSS layout ([CSS2], chapter 9) or XSL formatting [XSL], if the ‘overflow’ property has the value hidden or scroll, then the user agent will establish an initial clipping path equal to the bounds of the initial viewport; otherwise, the initial clipping path is set according to the clipping rules as defined in CSS2 ([CSS2], section 11.1.1).</para>
......
...@@ -8,7 +8,7 @@ using System.Globalization; ...@@ -8,7 +8,7 @@ using System.Globalization;
namespace Svg namespace Svg
{ {
/// <summary> /// <summary>
/// Represents a list of <see cref="SvgUnits"/> used with the <see cref="SvgPolyline"/> and <see cref="SvgPolygon"/>. /// Represents a list of <see cref="SvgUnit"/> used with the <see cref="SvgPolyline"/> and <see cref="SvgPolygon"/>.
/// </summary> /// </summary>
[TypeConverter(typeof(SvgPointCollectionConverter))] [TypeConverter(typeof(SvgPointCollectionConverter))]
public class SvgPointCollection : List<SvgUnit> public class SvgPointCollection : List<SvgUnit>
......
...@@ -62,7 +62,6 @@ namespace Svg ...@@ -62,7 +62,6 @@ namespace Svg
/// <summary> /// <summary>
/// Converts the current unit to one that can be used at render time. /// Converts the current unit to one that can be used at render time.
/// </summary> /// </summary>
/// <param name="boundable">The container element used as the basis for calculations</param>
/// <returns>The representation of the current unit in a device value (usually pixels).</returns> /// <returns>The representation of the current unit in a device value (usually pixels).</returns>
public float ToDeviceValue(ISvgRenderer renderer, UnitRenderingType renderType, SvgElement owner) public float ToDeviceValue(ISvgRenderer renderer, UnitRenderingType renderType, SvgElement owner)
{ {
...@@ -187,7 +186,7 @@ namespace Svg ...@@ -187,7 +186,7 @@ namespace Svg
/// <summary> /// <summary>
/// Converts the current unit to a percentage, if applicable. /// Converts the current unit to a percentage, if applicable.
/// </summary> /// </summary>
/// <returns>An <see cref="SvgUnit"/> of type <see cref="SvgUnitType.Perscentage"/>.</returns> /// <returns>An <see cref="SvgUnit"/> of type <see cref="SvgUnitType.Percentage"/>.</returns>
public SvgUnit ToPercentage() public SvgUnit ToPercentage()
{ {
switch (this.Type) switch (this.Type)
......
...@@ -7,7 +7,7 @@ using System.Linq; ...@@ -7,7 +7,7 @@ using System.Linq;
namespace Svg namespace Svg
{ {
/// <summary> /// <summary>
/// Represents a list of <see cref="SvgUnits"/>. /// Represents a list of <see cref="SvgUnit"/>.
/// </summary> /// </summary>
[TypeConverter(typeof(SvgUnitCollectionConverter))] [TypeConverter(typeof(SvgUnitCollectionConverter))]
public class SvgUnitCollection : List<SvgUnit> public class SvgUnitCollection : List<SvgUnit>
......
...@@ -36,7 +36,7 @@ namespace Svg.Document_Structure ...@@ -36,7 +36,7 @@ namespace Svg.Document_Structure
} }
/// <summary> /// <summary>
/// Gets the <see cref="GraphicsPath"/> for this element. /// Gets the <see cref="System.Drawing.Drawing2D.GraphicsPath"/> for this element.
/// </summary> /// </summary>
/// <value></value> /// <value></value>
public override System.Drawing.Drawing2D.GraphicsPath Path(ISvgRenderer renderer) public override System.Drawing.Drawing2D.GraphicsPath Path(ISvgRenderer renderer)
......
...@@ -23,7 +23,7 @@ namespace Svg.FilterEffects ...@@ -23,7 +23,7 @@ namespace Svg.FilterEffects
/// <summary> /// <summary>
/// list of <number>s /// list of numbers
/// The contents of values depends on the value of attribute type: /// The contents of values depends on the value of attribute type:
/// Note: this is not used in calculations to bitmap - used only to allow for svg xml output /// Note: this is not used in calculations to bitmap - used only to allow for svg xml output
/// </summary> /// </summary>
......
...@@ -28,7 +28,7 @@ namespace Svg ...@@ -28,7 +28,7 @@ namespace Svg
/// <summary> /// <summary>
/// Called by the underlying <see cref="SvgElement"/> when an element has been added to the /// Called by the underlying <see cref="SvgElement"/> when an element has been added to the
/// <see cref="Children"/> collection. /// 'Children' collection.
/// </summary> /// </summary>
/// <param name="child">The <see cref="SvgElement"/> that has been added.</param> /// <param name="child">The <see cref="SvgElement"/> that has been added.</param>
/// <param name="index">An <see cref="int"/> representing the index where the element was added to the collection.</param> /// <param name="index">An <see cref="int"/> representing the index where the element was added to the collection.</param>
...@@ -44,7 +44,7 @@ namespace Svg ...@@ -44,7 +44,7 @@ namespace Svg
/// <summary> /// <summary>
/// Called by the underlying <see cref="SvgElement"/> when an element has been removed from the /// Called by the underlying <see cref="SvgElement"/> when an element has been removed from the
/// <see cref="Children"/> collection. /// 'Children' collection.
/// </summary> /// </summary>
/// <param name="child">The <see cref="SvgElement"/> that has been removed.</param> /// <param name="child">The <see cref="SvgElement"/> that has been removed.</param>
protected override void RemoveElement(SvgElement child) protected override void RemoveElement(SvgElement child)
...@@ -122,8 +122,9 @@ namespace Svg ...@@ -122,8 +122,9 @@ namespace Svg
/// <summary> /// <summary>
/// Gets a <see cref="ColorBlend"/> representing the <see cref="SvgGradientServer"/>'s gradient stops. /// Gets a <see cref="ColorBlend"/> representing the <see cref="SvgGradientServer"/>'s gradient stops.
/// </summary> /// </summary>
/// <param name="owner">The parent <see cref="SvgVisualElement"/>.</param> /// <param name="renderer">The renderer <see cref="ISvgRenderer"/>.</param>
/// <param name="opacity">The opacity of the colour blend.</param> /// <param name="opacity">The opacity of the colour blend.</param>
/// <param name="radial">True if it's a radial gradiant.</param>
protected ColorBlend GetColorBlend(ISvgRenderer renderer, float opacity, bool radial) protected ColorBlend GetColorBlend(ISvgRenderer renderer, float opacity, bool radial)
{ {
int colourBlends = this.Stops.Count; int colourBlends = this.Stops.Count;
......
...@@ -501,7 +501,7 @@ namespace Svg ...@@ -501,7 +501,7 @@ namespace Svg
return result; return result;
} }
/// <remarks>http://community.topcoder.com/tc?module=Static&d1=tutorials&d2=geometry2</remarks> /// <remarks>http://community.topcoder.com/tc?module=Static&amp;d1=tutorials&amp;d2=geometry2</remarks>
private PointF? Intersection(LineF other) private PointF? Intersection(LineF other)
{ {
const int precision = 8; const int precision = 8;
......
...@@ -129,6 +129,7 @@ namespace Svg ...@@ -129,6 +129,7 @@ namespace Svg
/// </summary> /// </summary>
/// <param name="pRenderer"></param> /// <param name="pRenderer"></param>
/// <param name="pOwner"></param> /// <param name="pOwner"></param>
/// <param name="pRefPoint"></param>
/// <param name="pMarkerPoint1"></param> /// <param name="pMarkerPoint1"></param>
/// <param name="pMarkerPoint2"></param> /// <param name="pMarkerPoint2"></param>
public void RenderMarker(ISvgRenderer pRenderer, SvgVisualElement pOwner, PointF pRefPoint, PointF pMarkerPoint1, PointF pMarkerPoint2) public void RenderMarker(ISvgRenderer pRenderer, SvgVisualElement pOwner, PointF pRefPoint, PointF pMarkerPoint1, PointF pMarkerPoint2)
...@@ -150,6 +151,7 @@ namespace Svg ...@@ -150,6 +151,7 @@ namespace Svg
/// </summary> /// </summary>
/// <param name="pRenderer"></param> /// <param name="pRenderer"></param>
/// <param name="pOwner"></param> /// <param name="pOwner"></param>
/// <param name="pRefPoint"></param>
/// <param name="pMarkerPoint1"></param> /// <param name="pMarkerPoint1"></param>
/// <param name="pMarkerPoint2"></param> /// <param name="pMarkerPoint2"></param>
/// <param name="pMarkerPoint3"></param> /// <param name="pMarkerPoint3"></param>
...@@ -233,7 +235,6 @@ namespace Svg ...@@ -233,7 +235,6 @@ namespace Svg
/// <summary> /// <summary>
/// Create a pen that can be used to render this marker /// Create a pen that can be used to render this marker
/// </summary> /// </summary>
/// <param name="pStroke"></param>
/// <returns></returns> /// <returns></returns>
private Pen CreatePen(SvgVisualElement pPath, ISvgRenderer renderer) private Pen CreatePen(SvgVisualElement pPath, ISvgRenderer renderer)
{ {
...@@ -286,7 +287,7 @@ namespace Svg ...@@ -286,7 +287,7 @@ namespace Svg
/// <summary> /// <summary>
/// Adjust the given value to account for the height of the viewbox in the viewport /// Adjust the given value to account for the height of the viewbox in the viewport
/// </summary> /// </summary>
/// <param name="fWidth"></param> /// <param name="fHeight"></param>
/// <returns></returns> /// <returns></returns>
private float AdjustForViewBoxHeight(float fHeight) private float AdjustForViewBoxHeight(float fHeight)
{ {
......
...@@ -40,7 +40,9 @@ namespace Svg ...@@ -40,7 +40,9 @@ namespace Svg
/// Gets a <see cref="Brush"/> representing the current paint server. /// Gets a <see cref="Brush"/> representing the current paint server.
/// </summary> /// </summary>
/// <param name="styleOwner">The owner <see cref="SvgVisualElement"/>.</param> /// <param name="styleOwner">The owner <see cref="SvgVisualElement"/>.</param>
/// <param name="renderer">The renderer object.</param>
/// <param name="opacity">The opacity of the brush.</param> /// <param name="opacity">The opacity of the brush.</param>
/// <param name="forStroke">Not used.</param>
public abstract Brush GetBrush(SvgVisualElement styleOwner, ISvgRenderer renderer, float opacity, bool forStroke = false); public abstract Brush GetBrush(SvgVisualElement styleOwner, ISvgRenderer renderer, float opacity, bool forStroke = false);
/// <summary> /// <summary>
......
...@@ -171,7 +171,9 @@ namespace Svg ...@@ -171,7 +171,9 @@ namespace Svg
/// Gets a <see cref="Brush"/> representing the current paint server. /// Gets a <see cref="Brush"/> representing the current paint server.
/// </summary> /// </summary>
/// <param name="renderingElement">The owner <see cref="SvgVisualElement"/>.</param> /// <param name="renderingElement">The owner <see cref="SvgVisualElement"/>.</param>
/// <param name="renderer">The renderer object.</param>
/// <param name="opacity">The opacity of the brush.</param> /// <param name="opacity">The opacity of the brush.</param>
/// <param name="forStroke">Not used.</param>
public override Brush GetBrush(SvgVisualElement renderingElement, ISvgRenderer renderer, float opacity, bool forStroke = false) public override Brush GetBrush(SvgVisualElement renderingElement, ISvgRenderer renderer, float opacity, bool forStroke = false)
{ {
var chain = new List<SvgPatternServer>(); var chain = new List<SvgPatternServer>();
......
...@@ -210,6 +210,7 @@ namespace Svg ...@@ -210,6 +210,7 @@ namespace Svg
/// </summary> /// </summary>
/// <param name="bounds">Bounds that the path must contain</param> /// <param name="bounds">Bounds that the path must contain</param>
/// <param name="path">Path of the gradient</param> /// <param name="path">Path of the gradient</param>
/// <param name="graphics">Not used</param>
/// <returns>Scale factor</returns> /// <returns>Scale factor</returns>
/// <remarks> /// <remarks>
/// This method continually transforms the rectangle (fewer points) until it is contained by the path /// This method continually transforms the rectangle (fewer points) until it is contained by the path
......
...@@ -7,7 +7,7 @@ using System.ComponentModel; ...@@ -7,7 +7,7 @@ using System.ComponentModel;
namespace Svg namespace Svg
{ {
/// <summary> /// <summary>
/// The creator of SVG content might want to provide a hint about what tradeoffs to make as the browser renders <path> element or basic shapes. The shape-rendering attribute provides these hints. /// The creator of SVG content might want to provide a hint about what tradeoffs to make as the browser renders 'path' element or basic shapes. The shape-rendering attribute provides these hints.
/// </summary> /// </summary>
/// <references>https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/shape-rendering</references> /// <references>https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/shape-rendering</references>
/// <remarks> /// <remarks>
......
...@@ -61,6 +61,7 @@ ...@@ -61,6 +61,7 @@
<DocumentationFile> <DocumentationFile>
</DocumentationFile> </DocumentationFile>
<TreatWarningsAsErrors>false</TreatWarningsAsErrors> <TreatWarningsAsErrors>false</TreatWarningsAsErrors>
<NoWarn>1591</NoWarn>
</PropertyGroup> </PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' "> <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
<DebugType>PdbOnly</DebugType> <DebugType>PdbOnly</DebugType>
...@@ -74,6 +75,7 @@ ...@@ -74,6 +75,7 @@
<CodeAnalysisRuleSet>AllRules.ruleset</CodeAnalysisRuleSet> <CodeAnalysisRuleSet>AllRules.ruleset</CodeAnalysisRuleSet>
<DebugSymbols>false</DebugSymbols> <DebugSymbols>false</DebugSymbols>
<DocumentationFile>bin\Release\Svg.XML</DocumentationFile> <DocumentationFile>bin\Release\Svg.XML</DocumentationFile>
<NoWarn>1591</NoWarn>
</PropertyGroup> </PropertyGroup>
<PropertyGroup> <PropertyGroup>
<SignAssembly>true</SignAssembly> <SignAssembly>true</SignAssembly>
......
...@@ -47,7 +47,7 @@ namespace Svg ...@@ -47,7 +47,7 @@ namespace Svg
/// Checks whether the property value is the default value of the svg definition. /// Checks whether the property value is the default value of the svg definition.
/// </summary> /// </summary>
/// <param name="attributeName">Name of the svg attribute</param> /// <param name="attributeName">Name of the svg attribute</param>
/// <param name="propertyValue">.NET value of the attribute</param> /// <param name="value">.NET value of the attribute</param>
public static bool IsDefault(string attributeName, string value) public static bool IsDefault(string attributeName, string value)
{ {
if (_defaults.ContainsKey(attributeName)) if (_defaults.ContainsKey(attributeName))
......
...@@ -175,7 +175,7 @@ namespace Svg ...@@ -175,7 +175,7 @@ namespace Svg
} }
/// <summary> /// <summary>
/// Gets a collection of all child <see cref="SvgElements"/>. /// Gets a collection of all child <see cref="SvgElement"/> objects.
/// </summary> /// </summary>
public virtual SvgElementCollection Children public virtual SvgElementCollection Children
{ {
...@@ -776,7 +776,7 @@ namespace Svg ...@@ -776,7 +776,7 @@ namespace Svg
/// Recursive method to add up the paths of all children /// Recursive method to add up the paths of all children
/// </summary> /// </summary>
/// <param name="elem"></param> /// <param name="elem"></param>
/// <param name="path"></param> /// <param name="renderer"></param>
protected GraphicsPath GetPaths(SvgElement elem, ISvgRenderer renderer) protected GraphicsPath GetPaths(SvgElement elem, ISvgRenderer renderer)
{ {
var ret = new GraphicsPath(); var ret = new GraphicsPath();
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment