c++ - 狮身人面像: Correct way to document an enum?

通过Sphinx的C and C++ domains查看，它似乎没有对文档枚举(和更少的匿名枚举)进行文档记录的 native 支持。到目前为止，我将cpp:type::用作枚举类型，然后使用所有可能值及其描述的列表，但这似乎并不是处理它的理想方法，特别是因为它使引用某些值变得很麻烦(我仅引用类型，或在值前面添加一个额外的标记)。

有一个更好的方法吗？我将如何处理匿名枚举？

最佳答案

Sphinx现在支持enums

这是带有枚举值的示例:

.. enum-class:: partition_affinity_domain

   .. enumerator:: \
      not_applicable
      numa
      L4_cache
      L3_cache
      L2_cache
      L1_cache
      next_partitionab

关于c++ - 狮身人面像: Correct way to document an enum?，我们在Stack Overflow上找到一个类似的问题：https://stackoverflow.com/questions/17690437/