llvm/llvm-project

[llvm] Document non-trivial `llvm::DenseMapBase` member functions

Open

#166,155 创建于 2025年11月3日

在 GitHub 查看
 (7 评论) (0 反应) (2 负责人)C++ (26,378 star) (10,782 fork)batch import
documentationenhancementgood first issuellvm:adt

描述

There are (now?) some non-trivial memberfunctions in DenseMapBase that would be good to document, possibly adding a code sample.

From looking at https://llvm.org/doxygen/classllvm_1_1DenseMap.html, examples include:

  1. try_emplace
  2. insert_or_assign
  3. emplace_or_assign
  4. lookup_or
  5. operator[] - should specify what happens if the key isn't yet in the map.

贡献者指南

技术栈
cpp
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
half day
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
blocked
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
C++ basicsLLVM coding styleunderstanding of DenseMap
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
45
研究方向
The issue requests documentation for several non trivial DenseMapBase member functions (try emplace, insert or assign, etc.) with code samples. The primary file to modify is likely `llvm/include/llvm/ADT/DenseMap.h`, where these functions are defined. Check the existing documentation style in that file for consistency. The issue has two assignees, so check their progress or any linked branches before starting. The discussion in comments may provide additional guidance.