Skip to content

Commit 4cab5a1

Browse files
committed
[clang][ssaf][NFC] Improve doc for getLocalEntityNameForFunctionReturn
1 parent 8bde909 commit 4cab5a1

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

clang/include/clang/Analysis/Scalable/ASTEntityMapping.h

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,12 @@ namespace clang::ssaf {
3232
/// \return An EntityName if the declaration can be mapped, std::nullopt otherwise.
3333
std::optional<EntityName> getLocalEntityNameForDecl(const Decl* D);
3434

35-
/// Maps a function return type to an EntityName.
35+
/// Maps return entity of a function to an EntityName.
36+
/// The returned name uniquely identifies the return value of function \param FD.
3637
///
3738
/// \param FD The function declaration. Must not be null.
3839
///
39-
/// \return An EntityName for the function's return type.
40+
/// \return An EntityName for the function's return entity.
4041
std::optional<EntityName> getLocalEntityNameForFunctionReturn(const FunctionDecl* FD);
4142

4243
} // namespace clang::ssaf

0 commit comments

Comments
 (0)