hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2025-12-16 16:53:25 +01:00
Code Issues Packages Projects Releases Wiki Activity

update annotation docs to reference signatures

Browse Source
This commit is contained in:
Philip Ginsbach
2025-10-01 13:46:51 +01:00
parent 1408c245e0
commit 8160ef6e81
2 changed files with 18 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/codeql/ql-language-reference/annotations.rst
View File

@@ -126,7 +126,7 @@ body must also be annotated with ``cached``, otherwise a compiler error is repor
``deprecated``
==============
**Available for**: |classes|, |algebraic datatypes|, |member predicates|, |non-member predicates|, |imports|, |fields|, |modules|, |aliases|
**Available for**: |classes|, |algebraic datatypes|, |member predicates|, |non-member predicates|, |imports|, |fields|, |modules|, |aliases|, |signatures|
The ``deprecated`` annotation is applied to names that are outdated and scheduled for removal
in a future release of QL.
@@ -235,7 +235,7 @@ warning.
``private``
===========
**Available for**: |classes|, |algebraic datatypes|, |member predicates|, |non-member predicates|, |imports|, |fields|, |modules|, |aliases|
**Available for**: |classes|, |algebraic datatypes|, |member predicates|, |non-member predicates|, |imports|, |fields|, |modules|, |aliases|, |signatures|
The ``private`` annotation is used to prevent names from being exported.
@@ -461,7 +461,7 @@ For more information, see ":ref:`monotonic-aggregates`."
Binding sets
============
**Available for**: |classes|, |characteristic predicates|, |member predicates|, |non-member predicates|
**Available for**: |classes|, |characteristic predicates|, |member predicates|, |non-member predicates|, |predicate signatures|, |type signatures|
``bindingset[...]``
-------------------
@@ -491,3 +491,6 @@ The ``bindingset`` annotation takes a comma-separated list of variables.
.. |type-aliases| replace:: :ref:`type aliases <type-aliases>`
.. |algebraic datatypes| replace:: :ref:`algebraic datatypes <algebraic-datatypes>`
.. |expressions| replace:: :ref:`expressions <expressions>`
.. |signatures| replace:: :ref:`signatures <signatures>`
.. |predicate signatures| replace:: :ref:`predicate signatures <predicate-signatures>`
.. |type signatures| replace:: :ref:`type signatures <type-signatures>`

12
docs/codeql/ql-language-reference/signatures.rst
View File

@@ -10,6 +10,10 @@ Signatures
Parameterized modules use signatures as a type system for their parameters.
There are three categories of signatures: **predicate signatures**, **type signatures**, and **module signatures**.
.. index:: predicate signature
.. _predicate-signatures:
Predicate signatures
====================
@@ -36,6 +40,10 @@ For example:
signature int operator(int lhs, int rhs);
.. index:: type signature
.. _type-signatures:
Type signatures
===============
@@ -66,6 +74,10 @@ For example:
string toString();
}
.. index:: module signature
.. _module-signatures:
Module signatures
=================