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

Tidy up QLDoc spec

Browse Source
This commit is contained in:
Shati Patel
2020-02-13 14:45:07 +00:00
parent 2ce1ad1818
commit c5eec30713
1 changed files with 7 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/language/ql-spec/qldoc.rst
View File

@@ -1,7 +1,12 @@
QLDoc comment specification
===========================
This document is a specification for QLDoc comments in QL source files.
This document is a formal specification for QLDoc comments.
About QLDoc comments
--------------------
You can provide documentation for a QL entity by adding a QLDoc comment in the source file. The QLDoc comment is displayed as pop-up information in QL editors, for example when you hover over a predicate name.
Notation
--------
@@ -36,7 +41,7 @@ Content
The content of a QLDoc comment is interpreted as standard Markdown, with the following extensions:
- Fenced code blocks using \`s.
- Fenced code blocks using backticks.
- Automatic interpretation of links and email addresses.
- Use of appropriate characters for ellipses, dashes, apostrophes, and quotes.