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

Merge pull request #2105 from shati-patel/qldoc-spec

Browse Source 
Terminology update
This commit is contained in:
Alexander Eyers-Taylor
2019-10-09 17:02:35 +01:00
committed by GitHub
parent 6e8764d592 9bb1b4f68a
commit 70caa9b82c
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -18,18 +18,18 @@ Association
A QLDoc comment may be 'associated with' any of the following QL syntax elements:
- Class declarations
- Predicate declarations
- Method declarations
- Non-member predicate declarations
- Member predicate declarations
- Modules
For class, method, and predicate declarations, the associated QLDoc comment (if any) is the closest preceding QLDoc comment.
For class and predicate declarations, the associated QLDoc comment (if any) is the closest preceding QLDoc comment.
For modules, the associated QLDoc comment (if any) is the QLDoc comment which is the first element in the file, and moreover is not associated with any other QL element.
Inheritance
-----------
If a method has no directly associated QLDoc and overrides a set of methods which all have the same QLDoc, then the method inherits that QLDoc.
If a member predicate has no directly associated QLDoc and overrides a set of member predicates which all have the same QLDoc, then the member predicate inherits that QLDoc.
Content
-------