记录重新抛出错误的函数

Question

我想知道在 doxygen 中记录以下内容的正确方法是什么。

有一个定义一些验证器的类，例如：

class Validators {
    /**
    * @fn A
    * @brief sees if x is too large.
    * @param[in] x the input to validate
    * @throws runtime_error when otx is too large.
    */
    static void A(int x) {
        if (x > 5) {
            throw std::runtime_error("x too large");
        }
    }
};

在如下函数中使用这个 valdator：

#include "validator.h"

class MyClass {
public:
    void setX(int x) {
        Validators::A(x);
    }
};

我应该如何记录setX()重新抛出A()抛出的 runtime_error ，或者我根本不应该记录它？

Answer 1

为了巧妙地做到这一点，我不得不稍微更改我的代码：

#include "validator.h"
class MyClass {
public:
    void setX(int x) {
        try {
            Validators::A(x);
        }
        catch (std::runtime_error & e) {
            throw e
        }
    }
};

这样做再次将@throws添加到 Doxygen 是有意义的，现在它显然是重新抛出的。

Answer 2

你应该记录它对调用者的意义。 例如

class MyClass {
public:
    /**
    * @brief sets X
    * @param[in] x the new X
    * @throws runtime_error when x is invalid.
    */
    void setX(int x) {
        Validators::A(x);
    }
};