Skip to content
Browse files

add some missing documentation

  • Loading branch information...
1 parent 1b7aab3 commit 042795f0047e6bea45021b00d496e3b397bea936 @siegfriedpammer siegfriedpammer committed Oct 26, 2011
View
3 src/Libraries/AvalonEdit/ICSharpCode.AvalonEdit/Search/ISearchStrategy.cs
@@ -36,6 +36,9 @@ public interface ISearchStrategy : IEquatable<ISearchStrategy>
/// </summary>
public interface ISearchResult : ISegment
{
+ /// <summary>
+ /// Replaces parts of the replacement string with parts from the match. (e.g. $1)
+ /// </summary>
string ReplaceWith(string replacement);
}
View
33 src/Libraries/AvalonEdit/ICSharpCode.AvalonEdit/Search/SearchPanel.cs
@@ -21,6 +21,9 @@
namespace ICSharpCode.AvalonEdit.Search
{
+ /// <summary>
+ /// Provides search functionality for AvalonEdit. It is displayed in the top-right corner of the TextArea.
+ /// </summary>
public class SearchPanel : Control
{
TextArea textArea;
@@ -30,46 +33,76 @@ public class SearchPanel : Control
TextBox searchTextBox;
SearchPanelAdorner adorner;
+ /// <summary>
+ /// Dependency property for <see cref="UseRegex"/>.
+ /// </summary>
public static readonly DependencyProperty UseRegexProperty =
DependencyProperty.Register("UseRegex", typeof(bool), typeof(SearchPanel),
new FrameworkPropertyMetadata(false, SearchPatternChangedCallback));
+ /// <summary>
+ /// Gets/sets whether the search pattern should be interpreted as regular expression.
+ /// </summary>
public bool UseRegex {
get { return (bool)GetValue(UseRegexProperty); }
set { SetValue(UseRegexProperty, value); }
}
+ /// <summary>
+ /// Dependency property for <see cref="MatchCase"/>.
+ /// </summary>
public static readonly DependencyProperty MatchCaseProperty =
DependencyProperty.Register("MatchCase", typeof(bool), typeof(SearchPanel),
new FrameworkPropertyMetadata(false, SearchPatternChangedCallback));
+ /// <summary>
+ /// Gets/sets whether the search pattern should be interpreted case-sensitive.
+ /// </summary>
public bool MatchCase {
get { return (bool)GetValue(MatchCaseProperty); }
set { SetValue(MatchCaseProperty, value); }
}
+ /// <summary>
+ /// Dependency property for <see cref="WholeWords"/>.
+ /// </summary>
public static readonly DependencyProperty WholeWordsProperty =
DependencyProperty.Register("WholeWords", typeof(bool), typeof(SearchPanel),
new FrameworkPropertyMetadata(false, SearchPatternChangedCallback));
+ /// <summary>
+ /// Gets/sets whether the search pattern should only match whole words.
+ /// </summary>
public bool WholeWords {
get { return (bool)GetValue(WholeWordsProperty); }
set { SetValue(WholeWordsProperty, value); }
}
+ /// <summary>
+ /// Dependency property for <see cref="SearchPattern"/>.
+ /// </summary>
public static readonly DependencyProperty SearchPatternProperty =
DependencyProperty.Register("SearchPattern", typeof(string), typeof(SearchPanel),
new FrameworkPropertyMetadata("", SearchPatternChangedCallback));
+ /// <summary>
+ /// Gets/sets the search pattern.
+ /// </summary>
public string SearchPattern {
get { return (string)GetValue(SearchPatternProperty); }
set { SetValue(SearchPatternProperty, value); }
}
+ /// <summary>
+ /// Dependency property for <see cref="MarkerBrush"/>.
+ /// </summary>
public static readonly DependencyProperty MarkerBrushProperty =
DependencyProperty.Register("MarkerBrush", typeof(Brush), typeof(SearchPanel),
new FrameworkPropertyMetadata(Brushes.LightGreen, MarkerBrushChangedCallback));
+ /// <summary>
+ /// Gets/sets the Brush used for marking search results in the TextView.
+ /// </summary>
public Brush MarkerBrush {
get { return (Brush)GetValue(MarkerBrushProperty); }
set { SetValue(MarkerBrushProperty, value); }

0 comments on commit 042795f

Please sign in to comment.
Something went wrong with that request. Please try again.