Может ли Doxygen документировать блок методов с общими параметрами? - PullRequest
1 голос
/ 06 января 2020

У меня есть ситуация в C ++, где есть фабричные методы с разными именами и возвращаемыми значениями, но много общих параметров. Например:

SomeType1 *getSomeType1 (const std::string &name, int id);
SomeType2 *getSomeType2 (const std::string &name, int id, int specific_to_type2);
SomeType3 *getSomeType3 (const std::string &name, int id, int specific_to_type3);

За исключением моего реального случая, существует несколько десятков методов и от шести до семи общих параметров. Есть ли способ сказать Doxygen, чтобы определить общие параметры для блока связанных методов, как это? В противном случае, я застрял в том, чтобы повторять всю информацию для каждого метода, и он не только утомителен и громоздок, но его сложнее поддерживать и в конечном итоге трудно читать.

Я искал "Doxygon" и «повторяющиеся» или «повторяющиеся» методы и / или параметры, но безуспешно.

...