Игнорировать некоторые комментарии

Question

Я работаю с устаревшим кодом, для которого я генерирую документацию XML с использованием doxygen. У меня есть две проблемы с этим видом кода. Сначала он содержит некорректные комментарии. Например:

///@struct E  
enum E  
{
 E1, E2, E3;  
};

Это заставляет doxygen генерировать вывод для структуры с именем E, которого нет в коде. Моя вторая проблема с ссылками HTML. Например, для следующего ввода:

///@brief For info about this struct see: <a href="http://www.foo.com/bar&bar"\>  
struct S
{
  int i;
}

вывод, сгенерированный doxygen, не является допустимым XML, потому что & в ссылке неправильно экранирован.

По вышеуказанным причинам я бы хотел, чтобы doxygen проигнорировал некоторые комментарии. Это возможно?

Answer 1

Я не думаю, что у doxygen есть простой переключатель для этого, однако вы можете написать свою собственную программу INPUT_FILTER , чтобы очистить файл (например, удаляя комментарии) перед запуском doxygen.

Answer 2

Я заметил и проверил, что html-комментарии внутри комментария doxygen будут игнорироваться:

///@brief some comment here <--! ignored here --> also continues over.

Насколько вы не заметили, заметили ли вы \ & избегать ли это?Может быть, это решение для этой части.