[clang-tools-extra] r341639 - [clangd] NFC: Document URIDistance

[Kirill Bobyrev via cfe-commits]

Author: omtcyfz
Date: Fri Sep  7 02:18:58 2018
New Revision: 341639

URL: http://llvm.org/viewvc/llvm-project?rev=341639&view=rev
Log:
[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

Modified:
    clang-tools-extra/trunk/clangd/FileDistance.h

Modified: clang-tools-extra/trunk/clangd/FileDistance.h
URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/clangd/FileDistance.h?rev=341639&r1=341638&r2=341639&view=diff
==============================================================================
--- clang-tools-extra/trunk/clangd/FileDistance.h (original)
+++ clang-tools-extra/trunk/clangd/FileDistance.h Fri Sep  7 02:18:58 2018
@@ -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) {}