hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2026-04-30 11:15:13 +02:00
Code Issues Packages Projects Releases Wiki Activity

Remove links to QLDoc spec

Browse Source
This commit is contained in:
Shati Patel
2021-01-06 11:04:58 +00:00
parent 0bd8c55510
commit 203d74f255
3 changed files with 4 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/codeql/ql-language-reference/about-the-ql-language.rst
View File

@@ -44,7 +44,7 @@ When you write this process in QL, it closely resembles the above structure. Not
For more information about the important concepts and syntactic constructs of QL, see the individual reference topics such as ":doc:`Expressions <expressions>`" and ":doc:`Recursion <recursion>`."
The explanations and examples help you understand how the language works, and how to write more advanced QL code.
For formal specifications of the QL language and QLDoc comments, see the ":doc:`QL language specification <ql-language-specification>`" and ":doc:`QLDoc comment specification <qldoc-comment-specification>`."
For a formal specification of the QL language, see the ":doc:`QL language specification <ql-language-specification>`."
QL and object orientation
-------------------------

6
docs/codeql/ql-language-reference/lexical-syntax.rst
View File

@@ -16,12 +16,10 @@ For an overview of the lexical syntax, see "`Lexical syntax
Comments
********
All standard one-line and multiline comments, as described in the "`QL language specification
<ql-language-specification#comments>`_," are ignored by the QL
All standard one-line and multiline comments are ignored by the QL
compiler and are only visible in the source code.
You can also write another kind of comment, namely **QLDoc comments**. These comments describe
QL entities and are displayed as pop-up information in QL editors. For information about QLDoc
comments, see the ":doc:`QLDoc comment specification <qldoc-comment-specification>`."
QL entities and are displayed as pop-up information in QL editors.
The following example uses these three different kinds of comments:

2
docs/codeql/writing-codeql-queries/metadata-for-codeql-queries.rst
View File

@@ -8,7 +8,7 @@ Metadata tells users important information about CodeQL queries. You must includ
About query metadata
--------------------
Any query that is run as part of an analysis includes a number of properties, known as query metadata. Metadata is included at the top of each query file as the content of a :ref:`QLDoc <qldoc-comment-specification>` comment.
Any query that is run as part of an analysis includes a number of properties, known as query metadata. Metadata is included at the top of each query file as the content of a QLDoc comment.
This metadata tells LGTM and the CodeQL :ref:`extension for VS Code <codeql-for-visual-studio-code>` how to handle the query and display its results correctly.
It also gives other users information about what the query results mean. For more information on query metadata, see the `query metadata style guide <https://github.com/github/codeql/blob/main/docs/query-metadata-style-guide.md>`__ in our `open source repository <https://github.com/github/codeql>`__ on GitHub.