Concepts: Add some architecture documentation

This commit is contained in:
Rasmus Wriedt Larsen
2022-03-17 13:45:31 +01:00
parent 36c421346b
commit 2b9408b0c3
3 changed files with 27 additions and 3 deletions

View File

@@ -1,5 +1,13 @@
/**
* Provides Concepts which are shared across languages. See `Concepts.qll` for details.
* Provides Concepts which are shared across languages.
*
* Each language will have a language specific `Concepts.qll` file that can import the
* shared concepts from this file. A language can either re-export the concept directly,
* or can add additional member-predicates that are needed for that language.
*
* Moving forward, `Concepts.qll` will be the staging ground for brand new concepts from
* each language, but we will maintain a discipline of moving those concepts to
* `ConceptsShared.qll` ASAP.
*/
private import ConceptsImports