Skip to content

Commit a14379b

Browse files
committed
C++: Document external package tables in dbscheme
1 parent 79b08d2 commit a14379b

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

cpp/ql/src/semmlecode.cpp.dbscheme

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -181,17 +181,24 @@ tokens(
181181
int endColumn : int ref
182182
);
183183

184-
/*
185-
* Mapping of header files to packages
184+
/**
185+
* Information about packages that provide code used during compilation.
186+
* The `id` is just a unique identifier.
187+
* The `namespace` is typically the name of the package manager that
188+
* provided the package (e.g. "dpkg" or "yum").
189+
* The `package_name` is the name of the package, and `version` is its
190+
* version (as a string).
186191
*/
187-
188192
external_packages(
189193
unique int id: @external_package,
190-
string namespace : string ref, // "dpkg", "yum", ...
194+
string namespace : string ref,
191195
string package_name : string ref,
192196
string version : string ref
193197
);
194198

199+
/**
200+
* Holds if File `fileid` was provided by package `package`.
201+
*/
195202
header_to_external_package(
196203
int fileid : @file ref,
197204
int package : @external_package ref

0 commit comments

Comments
 (0)