hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2026-05-03 12:45:27 +02:00
Code Issues Packages Projects Releases Wiki Activity

C#: rename XmlComment to XmlCommentLine to avoid naming conflict

Browse Source
This commit is contained in:
Erik Krogh Kristensen
2022-03-03 20:50:22 +01:00
parent 69353bb014
commit 23191b1f2c
3 changed files with 13 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
csharp/ql/lib/semmle/code/csharp/Comments.qll
View File

@@ -11,7 +11,7 @@ import Location
/**
* A single line of comment.
*
* Either a single line comment (`SinglelineComment`), an XML comment (`XmlComment`),
* Either a single line comment (`SinglelineComment`), an XML comment (`XmlCommentLine`),
* or a line in a multi-line comment (`MultilineComment`).
*/
class CommentLine extends @commentline {
@@ -66,7 +66,7 @@ class MultilineComment extends CommentLine, @multilinecomment {
* /// </summary>
* ```
*/
class XmlComment extends CommentLine, @xmldoccomment {
class XmlCommentLine extends CommentLine, @xmldoccomment {
override string toString() { result = "/// ..." }
private string xmlAttributeRegex() {
@@ -196,7 +196,7 @@ class CommentBlock extends @commentblock {
/** Holds if this block consists entirely of XML comments. */
predicate isXmlCommentBlock() {
forall(CommentLine l | l = getAChild() | l instanceof XmlComment)
forall(CommentLine l | l = getAChild() | l instanceof XmlCommentLine)
}
/** Gets a `CommentLine` containing text. */

14
csharp/ql/src/Documentation/Documentation.qll
View File

@@ -26,7 +26,7 @@ class SourceMethodOrConstructor extends SourceDeclaration, Callable {
}
/** Gets an XML comment bound to this declaration. */
XmlComment getADeclarationXmlComment(Declaration d) {
XmlCommentLine getADeclarationXmlComment(Declaration d) {
result = getADeclarationCommentBlock(d).getAChild()
}
@@ -58,7 +58,7 @@ predicate isDocumentationNeeded(Modifiable decl) {
}
/** An XML comment containing a `<returns>` tag. */
class ReturnsXmlComment extends XmlComment {
class ReturnsXmlComment extends XmlCommentLine {
ReturnsXmlComment() { this.getOpenTag(_) = "returns" }
/** Holds if the element in this comment has a body at offset `offset`. */
@@ -72,7 +72,7 @@ class ReturnsXmlComment extends XmlComment {
}
/** An XML comment containing an `<exception>` tag. */
class ExceptionXmlComment extends XmlComment {
class ExceptionXmlComment extends XmlCommentLine {
ExceptionXmlComment() { this.getOpenTag(_) = "exception" }
/** Gets a `cref` attribute at offset `offset`, if any. */
@@ -83,7 +83,7 @@ class ExceptionXmlComment extends XmlComment {
}
/** An XML comment containing a `<param>` tag. */
class ParamXmlComment extends XmlComment {
class ParamXmlComment extends XmlCommentLine {
ParamXmlComment() { this.getOpenTag(_) = "param" }
/** Gets the name of this parameter at offset `offset`. */
@@ -94,7 +94,7 @@ class ParamXmlComment extends XmlComment {
}
/** An XML comment containing a `<typeparam>` tag. */
class TypeparamXmlComment extends XmlComment {
class TypeparamXmlComment extends XmlCommentLine {
TypeparamXmlComment() { this.getOpenTag(_) = "typeparam" }
/** Gets the `name` attribute of this element at offset `offset`. */
@@ -105,7 +105,7 @@ class TypeparamXmlComment extends XmlComment {
}
/** An XML comment containing a `<summary>` tag. */
class SummaryXmlComment extends XmlComment {
class SummaryXmlComment extends XmlCommentLine {
SummaryXmlComment() { this.getOpenTag(_) = "summary" }
/** Holds if the element in this comment has a body at offset `offset`. */
@@ -119,6 +119,6 @@ class SummaryXmlComment extends XmlComment {
}
/** An XML comment containing an `<inheritdoc>` tag. */
class InheritDocXmlComment extends XmlComment {
class InheritDocXmlComment extends XmlCommentLine {
InheritDocXmlComment() { this.getOpenTag(_) = "inheritdoc" }
}

4
csharp/ql/test/library-tests/comments/Comments.ql
View File

@@ -21,6 +21,8 @@ query predicate multilineComment(
commentLine(c, l, numLines, text, rawText)
}
query predicate xmlComment(CommentBlock c, XmlComment l, int numLines, string text, string rawText) {
query predicate xmlComment(
CommentBlock c, XmlCommentLine l, int numLines, string text, string rawText
) {
commentLine(c, l, numLines, text, rawText)
}