Skip to content

Commit 45a0e1b

Browse files
Add short module descriptions for modules that didn't have one
1 parent 124eccb commit 45a0e1b

23 files changed

Lines changed: 44 additions & 0 deletions

src/qtil/fn/All.qll

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
/** A module that defines the set of all values of a given type. */
2+
13
private import qtil.parameterization.SignatureTypes
24
private import qtil.fn.FnTypes
35
private import qtil.fn.Tp

src/qtil/fn/Fn.qll

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1+
/** A module that defines function-like predicate signatures of various arities, generated for use with parameterized modules. */
2+
13
import qtil.fn.generated.Fn

src/qtil/fn/Ordering.qll

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1+
/** A module that defines ordering-related predicate signatures for use with ordered data structures. */
2+
13
import qtil.fn.generated.Ordering

src/qtil/fn/ResultSet.qll

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
/** A module that defines the set of result values produced by a predicate. */
2+
13
private import qtil.parameterization.SignatureTypes
24
private import qtil.fn.FnTypes
35
private import qtil.fn.Tp

src/qtil/inheritance/Finitize.qll

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
/** A module to convert an infinite type into a finite type by constraining it with a predicate. */
2+
13
private import qtil.parameterization.SignatureTypes
24
private import qtil.parameterization.SignaturePredicates
35
private import qtil.parameterization.Finalize

src/qtil/inheritance/Instance.qll

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
/** A module that simplifies `instanceof` inheritance in CodeQL by automatically providing `toString()` and a convenience cast member `inst()`. */
2+
13
private import qtil.parameterization.SignatureTypes
24

35
/**

src/qtil/list/CondensedList.qll

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
/** A module similar to `Ordered`, which takes orderable data and optional groupings to make it easy to traverse as a list. */
2+
13
private import qtil.parameterization.SignatureTypes
24
private import qtil.parameterization.SignaturePredicates
35
private import qtil.inheritance.Instance

src/qtil/list/Ordered.qll

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
/** A module for adding `getNext()` and `getPrevious()` traversal predicates to orderable data, with optional grouping support. */
2+
13
private import qtil.list.CondensedList
24
private import qtil.parameterization.Finalize
35
private import qtil.parameterization.SignatureTypes

src/qtil/locations/NullLocation.qll

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
/** This module provides a `NullLocation` class that can be convenient for implementing optional placeholder in an alert message. */
2+
13
private import codeql.util.Unit
24
private import codeql.util.Option
35
private import codeql.util.Location

src/qtil/locations/OptionalLocation.qll

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
/** A module providing an `OptionalLocation` class that behaves like `Option<Location>` and implements the `hasLocation()` predicate expected by the CodeQL engine. */
2+
13
private import codeql.util.Option
24
private import codeql.util.Location
35
private import qtil.parameterization.Finalize

0 commit comments

Comments
 (0)