Skip to content

Commit 5f78bbb

Browse files
committed
add missing documentation
1 parent 543bd28 commit 5f78bbb

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

ruby/ql/lib/codeql/ruby/Concepts.qll

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -586,25 +586,31 @@ module OrmInstantiation {
586586

587587
/**
588588
* A data-flow node that may set or unset Cross-site request forgery protection.
589-
* `getVerificationSetting() = false` corresponds to disabling verification.
590589
*
591590
* Extend this class to refine existing API models. If you want to model new APIs,
592591
* extend `CSRFProtectionSetting::Range` instead.
593592
*/
594593
class CSRFProtectionSetting extends DataFlow::Node instanceof CSRFProtectionSetting::Range {
594+
/**
595+
* Gets the boolean value corresponding to if CSRF protection is enabled
596+
* (`true`) or disabled (`false`) by this node.
597+
*/
595598
boolean getVerificationSetting() { result = super.getVerificationSetting() }
596599
}
597600

598601
/** Provides a class for modeling new CSRF protection setting APIs. */
599602
module CSRFProtectionSetting {
600603
/**
601604
* A data-flow node that may set or unset Cross-site request forgery protection.
602-
* `getVerificationSetting() = false` corresponds to disabling verification.
603605
*
604606
* Extend this class to model new APIs. If you want to refine existing API models,
605607
* extend `CSRFProtectionSetting` instead.
606608
*/
607609
abstract class Range extends DataFlow::Node {
610+
/**
611+
* Gets the boolean value corresponding to if CSRF protection is enabled
612+
* (`true`) or disabled (`false`) by this node.
613+
*/
608614
abstract boolean getVerificationSetting();
609615
}
610616
}

0 commit comments

Comments
 (0)