================
@@ -0,0 +1,47 @@
+//===- EntityName.h ---------------------------------------------*- C++ 
-*-===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM 
Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef LLVM_CLANG_ANALYSIS_SCALABLE_ENTITY_NAME_H
+#define LLVM_CLANG_ANALYSIS_SCALABLE_ENTITY_NAME_H
+
+#include "clang/Analysis/Scalable/Model/BuildNamespace.h"
+#include "llvm/ADT/SmallString.h"
+#include "llvm/ADT/StringRef.h"
+#include <string>
+
+namespace clang {
+namespace ssaf {
+
+/// Uniquely identifies an entity in a program.
+///
+/// EntityName provides a globally unique identifier for program entities that 
remains
+/// stable across compilation boundaries. This enables whole-program analysis 
to track
+/// and relate entities across separately compiled translation units.
+class EntityName {
+  std::string USR;
----------------
ymand wrote:

I think it would be helpful to explain the roles of these fields. Perhaps copy 
some of the information from the PR description. To the casual reader "USR" 
won't have much meaning and since the type is string that won't inform them 
either. Additionally, the need for the suffix won't be obvious. Similarly, the 
role of `Namespace` in distinguishing between otherwise identical entities.

Alternatively, provide a detailed explanation on the class comments or the 
constructor.

https://github.com/llvm/llvm-project/pull/169131
_______________________________________________
cfe-commits mailing list
[email protected]
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits

Reply via email to