[clangd] NFC: Document URIDistance

`URIDistance` constructor should mention that `Sources` must contain
*absolute paths*, not URIs. This is not very clear when looking at the
interface, especially given that `distance(...)` accepts `URI`, not an
absolute path which can give the wrong impression.

Reviewed By: sammccall

Differential Revision: https://reviews.llvm.org/D51691

llvm-svn: 341639
This commit is contained in:
Kirill Bobyrev 2018-09-07 09:18:58 +00:00
parent f1510528dd
commit e5536b972f
1 changed files with 1 additions and 0 deletions

View File

@ -89,6 +89,7 @@ private:
// comparison on the bodies.
class URIDistance {
public:
// \p Sources must contain absolute paths, not URIs.
URIDistance(llvm::StringMap<SourceParams> Sources,
const FileDistanceOptions &Opts = {})
: Sources(Sources), Opts(Opts) {}