Skip to content

Commit bd9c9c2

Browse files
committed
Amend doc-comments in IModuleRewriter
The Rewrite member is no longer on the interface.
1 parent 4494b8d commit bd9c9c2

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

Rubberduck.Parsing/Rewriter/IModuleRewriter.cs

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,91 +10,91 @@ public interface IModuleRewriter
1010
bool IsDirty { get; }
1111

1212
/// <summary>
13-
/// Removes all tokens for specified <see cref="Declaration"/>. Use <see cref="Rewrite"/> method to apply changes.
13+
/// Removes all tokens for specified <see cref="Declaration"/>. Use <see cref="GetText"/> to get the changed module code.
1414
/// </summary>
1515
/// <param name="target">The <see cref="Declaration"/> to remove.</param>
1616
/// <remarks>Removes a line that would be left empty by the removal of the declaration.</remarks>
1717
void Remove(Declaration target);
1818
/// <summary>
19-
/// Removes all tokens in specified context. Use <see cref="Rewrite"/> method to apply changes.
19+
/// Removes all tokens in specified context. Use <see cref="GetText"/> to get the changed module code.
2020
/// </summary>
2121
/// <param name="target">The <see cref="ParserRuleContext"/> to remove.</param>
2222
/// <remarks>Removes a line that would be left empty by the removal of the identifier reference token.</remarks>
2323
void Remove(ParserRuleContext target);
2424
/// <summary>
25-
/// Removes all tokens for specified <see cref="IToken"/>. Use <see cref="Rewrite"/> method to apply changes.
25+
/// Removes all tokens for specified <see cref="IToken"/>. Use <see cref="GetText"/> to get the changed module code.
2626
/// </summary>
2727
/// <param name="target">The <see cref="IToken"/> to remove.</param>
2828
/// <remarks>Removes a line that would be left empty by the removal of the identifier reference token.</remarks>
2929
void Remove(IToken target);
3030
/// <summary>
31-
/// Removes all tokens for specified <see cref="ITerminalNode"/>. Use <see cref="Rewrite"/> method to apply changes.
31+
/// Removes all tokens for specified <see cref="ITerminalNode"/>. Use <see cref="GetText"/> to get the changed module code.
3232
/// </summary>
3333
/// <param name="target">The <see cref="ITerminalNode"/> to remove.</param>
3434
/// <remarks>Removes a line that would be left empty by the removal of the identifier reference token.</remarks>
3535
void Remove(ITerminalNode target);
3636
/// <summary>
37-
/// Removes all tokens for specified <see cref="IParseTree"/>. Use <see cref="Rewrite"/> method to apply changes.
37+
/// Removes all tokens for specified <see cref="IParseTree"/>. Use <see cref="GetText"/> to get the changed module code.
3838
/// </summary>
3939
/// <param name="target">The <see cref="IParseTree"/> to remove.</param>
4040
/// <remarks>Removes a line that would be left empty by the removal of the identifier reference token.</remarks>
4141
void Remove(IParseTree target);
4242

4343
/// <summary>
44-
/// Removes all tokens from the start of the first node to the end of the second node.
44+
/// Removes all tokens from the start of the first node to the end of the second node. Use <see cref="GetText"/> to get the changed module code.
4545
/// </summary>
4646
/// <param name="start">The start index to remove.</param>
4747
/// <param name="stop">The end index to remove.</param>
4848
void RemoveRange(int start, int stop);
4949

5050
/// <summary>
51-
/// Replaces all tokens for specified <see cref="Declaration"/> with specified content. Use <see cref="Rewrite"/> method to apply changes.
51+
/// Replaces all tokens for specified <see cref="Declaration"/> with specified content. Use <see cref="GetText"/> to get the changed module code.
5252
/// </summary>
5353
/// <param name="target">The <see cref="Declaration"/> to replace.</param>
5454
/// <param name="content">The literal replacement for the declaration.</param>
5555
/// <remarks>Useful for adding/removing e.g. access modifiers.</remarks>
5656
void Replace(Declaration target, string content);
5757
/// <summary>
58-
/// Replaces all tokens for specified <see cref="ParserRuleContext"/> with specified content. Use <see cref="Rewrite"/> method to apply changes.
58+
/// Replaces all tokens for specified <see cref="ParserRuleContext"/> with specified content. Use <see cref="GetText"/> to get the changed module code.
5959
/// </summary>
6060
/// <param name="target">The <see cref="ParserRuleContext"/> to replace.</param>
6161
/// <param name="content">The literal replacement for the expression.</param>
6262
void Replace(ParserRuleContext target, string content);
6363
/// <summary>
64-
/// Replaces specified token with specified content. Use <see cref="Rewrite"/> method to apply changes.
64+
/// Replaces specified token with specified content. Use <see cref="GetText"/> to get the changed module code.
6565
/// </summary>
6666
/// <param name="token">The <see cref="IToken"/> to replace.</param>
6767
/// <param name="content">The literal replacement for the expression.</param>
6868
void Replace(IToken token, string content);
6969
/// <summary>
70-
/// Replaces specified token with specified content. Use <see cref="Rewrite"/> method to apply changes.
70+
/// Replaces specified token with specified content. Use <see cref="GetText"/> to get the changed module code.
7171
/// </summary>
7272
/// <param name="target">The <see cref="ITerminalNode"/> to replace.</param>
7373
/// <param name="content">The literal replacement for the expression.</param>
7474
void Replace(ITerminalNode target, string content);
7575
/// <summary>
76-
/// Replaces specified token with specified content. Use <see cref="Rewrite"/> method to apply changes.
76+
/// Replaces specified token with specified content. Use <see cref="GetText"/> to get the changed module code.
7777
/// </summary>
7878
/// <param name="target">The <see cref="IParseTree"/> to replace.</param>
7979
/// <param name="content">The literal replacement for the expression.</param>
8080
void Replace(IParseTree target, string content);
8181

8282
/// <summary>
83-
/// Replaces specified interval with specified content. Use <see cref="Rewrite"/> method to apply changes.
83+
/// Replaces specified interval with specified content. Use <see cref="GetText"/> to get the changed module code.
8484
/// </summary>
8585
/// <param name="tokenInterval">The <see cref="Interval"/> to replace.</param>
8686
/// <param name="content">The literal replacement for the expression.</param>
8787
void Replace(Interval tokenInterval, string content);
8888

8989
/// <summary>
90-
/// Inserts specified content before the specified token index in the module. Use <see cref="Rewrite"/> method to apply changes.
90+
/// Inserts specified content before the specified token index in the module. Use <see cref="GetText"/> to get the changed module code.
9191
/// </summary>
9292
/// <param name="tokenIndex">The index of the insertion point in the module's lexer token stream.</param>
9393
/// <param name="content">The literal content to insert.</param>
9494
void InsertBefore(int tokenIndex, string content);
9595

9696
/// <summary>
97-
/// Inserts specified content after the specified token index in the module. Use <see cref="Rewrite"/> method to apply changes.
97+
/// Inserts specified content after the specified token index in the module. Use <see cref="GetText"/> to get the changed module code.
9898
/// </summary>
9999
/// <param name="tokenIndex">The index of the insertion point in the module's lexer token stream.</param>
100100
/// <param name="content">The literal content to insert.</param>

0 commit comments

Comments
 (0)