Browse Source

Add missing documentation comment.

pull/28/head
Daniel Grunwald 13 years ago
parent
commit
884448d519
  1. 16
      src/Libraries/AvalonEdit/ICSharpCode.AvalonEdit/Rendering/BackgroundGeometryBuilder.cs

16
src/Libraries/AvalonEdit/ICSharpCode.AvalonEdit/Rendering/BackgroundGeometryBuilder.cs

@ -65,6 +65,14 @@ namespace ICSharpCode.AvalonEdit.Rendering
} }
} }
/// <summary>
/// Adds a rectangle to the geometry.
/// </summary>
/// <remarks>
/// This overload will align the coordinates according to
/// <see cref="AlignToWholePixels"/> or <see cref="AlignToMiddleOfPixels"/>.
/// Use the <see cref="AddRectangle(double,double,double,double)"/>-overload instead if the coordinates should not be aligned.
/// </remarks>
public void AddRectangle(TextView textView, Rect rectangle) public void AddRectangle(TextView textView, Rect rectangle)
{ {
AddRectangle(PixelSnapHelpers.GetPixelSize(textView), rectangle); AddRectangle(PixelSnapHelpers.GetPixelSize(textView), rectangle);
@ -89,7 +97,8 @@ namespace ICSharpCode.AvalonEdit.Rendering
/// <summary> /// <summary>
/// Calculates the list of rectangle where the segment in shown. /// Calculates the list of rectangle where the segment in shown.
/// This returns one rectangle for each line inside the segment. /// This method usually returns one rectangle for each line inside the segment
/// (but potentially more, e.g. when bidirectional text is involved).
/// </summary> /// </summary>
public static IEnumerable<Rect> GetRectsForSegment(TextView textView, ISegment segment, bool extendToFullWidthAtLineEnd = false) public static IEnumerable<Rect> GetRectsForSegment(TextView textView, ISegment segment, bool extendToFullWidthAtLineEnd = false)
{ {
@ -232,6 +241,11 @@ namespace ICSharpCode.AvalonEdit.Rendering
/// <summary> /// <summary>
/// Adds a rectangle to the geometry. /// Adds a rectangle to the geometry.
/// </summary> /// </summary>
/// <remarks>
/// This overload assumes that the coordinates are aligned properly
/// (see <see cref="AlignToWholePixels"/>, <see cref="AlignToMiddleOfPixels"/>).
/// Use the <see cref="AddRectangle(TextView,Rect)"/>-overload instead if the coordinates are not yet aligned.
/// </remarks>
public void AddRectangle(double left, double top, double right, double bottom) public void AddRectangle(double left, double top, double right, double bottom)
{ {
if (!top.IsClose(lastBottom)) { if (!top.IsClose(lastBottom)) {

Loading…
Cancel
Save