Skip to content

Commit fbab8f8

Browse files
authored
Merge pull request #4972 from Marcono1234/marcono1234/qldoc-link-fixes
Approved by shati-patel
2 parents e2af176 + 47470e0 commit fbab8f8

File tree

3 files changed

+4
-2
lines changed

3 files changed

+4
-2
lines changed

docs/codeql/ql-language-reference/ql-language-specification.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -470,6 +470,8 @@ A QLDoc comment is a *qldoc comment start*, followed by a *qldoc comment body*,
470470

471471
The "content" of a QLDoc comment is the comment body of the comment, omitting the initial ``/**``, the trailing ``*/``, and the leading whitespace followed by ``*`` on each internal line.
472472

473+
For more information about how the content is interpreted, see see "`QLDoc <#qldoc>`__" below.
474+
473475
Keywords
474476
~~~~~~~~
475477

docs/qldoc-style-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Valid QL comments are known as QLDoc. This document describes the recommended st
66

77
### General requirements
88

9-
1. Documentation must adhere to the [QLDoc specification](https://help.semmle.com/QL/ql-handbook/qldoc.html).
9+
1. Documentation must adhere to the [QLDoc specification](https://codeql.github.com/docs/ql-language-reference/ql-language-specification/#qldoc).
1010
1. Documentation comments should be appropriate for users of the code.
1111
1. Documentation for maintainers of the code must use normal comments.
1212
1. Use `/** ... */` for documentation, even for single line comments.

docs/query-metadata-style-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ For examples of query files for the languages supported by CodeQL, visit the fol
2626

2727
## Metadata area
2828

29-
Query file metadata contains important information that defines the identifier and purpose of the query. The metadata is included as the content of a valid [QLDoc](https://help.semmle.com/QL/ql-handbook/qldoc.html) comment, on lines with leading whitespace followed by `*`, between an initial `/**` and a trailing `*/`. For example:
29+
Query file metadata contains important information that defines the identifier and purpose of the query. The metadata is included as the content of a valid [QLDoc](https://codeql.github.com/docs/ql-language-reference/ql-language-specification/#qldoc) comment, on lines with leading whitespace followed by `*`, between an initial `/**` and a trailing `*/`. For example:
3030

3131
```
3232
/**

0 commit comments

Comments
 (0)