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

Question

浏览 C and C++ domains Sphinx，它似乎没有对记录枚举(更不用说匿名枚举)的原生支持。截至目前，我使用 cpp:type:: 作为枚举类型，然后是所有可能值及其描述的列表，但这似乎不是处理它的理想方式，特别是因为它使引用某些值变得很痛苦(我要么只引用类型，要么在值前面添加一个额外的标记)。

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

Answer 1

Github上的一个项目spdylay，好像有办法。头文件之一位于 https://github.com/tatsuhiro-t/spdylay/blob/master/lib/includes/spdylay/spdylay.h有这样的代码:

/**
 * @enum
 * Error codes used in the Spdylay library.
 */
typedef enum {
  /**
   * Invalid argument passed.
   */
  SPDYLAY_ERR_INVALID_ARGUMENT = -501,
  /**
   * Zlib error.
   */
  SPDYLAY_ERR_ZLIB = -502,
} spdylay_error;

在 https://github.com/tatsuhiro-t/spdylay/tree/master/doc 上有一些关于他们如何做的描述，其中包括使用名为 mkapiref.py 的 API 生成器，可在 https://github.com/tatsuhiro-t/spdylay/blob/master/doc/mkapiref.py

它为这个例子生成的 RST 是

.. type:: spdylay_error

    Error codes used in the Spdylay library.

    .. macro:: SPDYLAY_ERR_INVALID_ARGUMENT

        (``-501``) 
        Invalid argument passed.
    .. macro:: SPDYLAY_ERR_ZLIB

        (``-502``) 
        Zlib error.

你可以看看它是否对你有用。