псевдоним doxygen с аргументами: (классическая) проблема linebr

  • рассмотрите следующий псевдоним doxygen:
ALIASES += "sbl_add_package_main_class{4}=\addtogroup \1-ref-manual ^^ @{ ^^ \class \2 ^^ \brief \3 ^^ \4 ^^ @}"

или эквивалентно

ALIASES += sbl_add_package_main_class{4}="\addtogroup \1-ref-manual ^^ @{ ^^ \class \2 ^^ \brief \3 ^^ \4 ^^ @}"
  • после запуска doxygen (1.8.18) на следующий код C ++
  /**
       \sbl_add_package_main_class{Molecular_potential_energy, T_Phi_psi_dihedral_angles_visitor,
        Defines iterator over all successive pairs of dihedrals.,
       \details Defines iterator over all successive pairs of dihedrals.  
       \tparam CovalentStructure The type of the input covalent structure
       }
    */  
    template <class CovalentStructure>
    class T_Phi_psi_dihedral_angles_visitor
    {
      
    public:
      
      typedef T_Phi_psi_dihedral_angles_visitor<CovalentStructure> Self;
      typedef CovalentStructure                               Covalent_structure;

      static inline Iterator begin(const CovalentStructure& C);

      static inline Iterator end(const CovalentStructure& C);
      
    };//end class T_Phi_psi_dihedral_angles_visitor
  • Я получаю следующее предупреждение:
warning: the name '\_linebr' supplied as the argument of the \class, \struct, \union, or \include command is not an input file

что для меня не имеет никакого смысла, поскольку второй аргумент T_Phi_psi_dihedral_angles_visitor сформирован правильно.

Я пытался добавить / удалить возврат каретки, добавить / удалить ^^ в псевдониме ... полный провал!

любая подсказка !?

большое спасибо, Фредерик.


person fcazals    schedule 02.09.2020    source источник
comment
Тестировал с 1.8.18 и 1.8.20, и в обоих случаях получаю предупреждение. Похоже на ошибку. Лучше всего создать проблему в трекере проблем doxygen: github.com/doxygen/doxygen/issues/   -  person albert    schedule 02.09.2020


Ответы (1)


На основе версии 1.8.20 я только что отправил предложенный патч в github (запрос на перенос 8003, https://github.com/doxygen/doxygen/pull/8003).

Далее обратите внимание:

  • ^^ между аргументами \3 и \4 не должно присутствовать (приведет к предупреждению), \details следит за тем, чтобы \brief закончился. Эти предупреждения подлежат дальнейшему изучению.
  • физические символы новой строки также используются, поэтому их следует использовать с осторожностью.
  • в конце строки \details также есть 2 пробела, я не знаю, намеренно они там или нет, но (по крайней мере) 2 пробела в конце строки означают дополнительную новую строку в синтаксисе Markdown.

Изменить

  • относительно предупреждений для ^^ между \3 и `4` я только что отправил предлагаемый патч в github (запрос на перенос 8004, https://github.com/doxygen/doxygen/pull/8004).

Изменить 17 сентября 2020 г. Оба упомянутых предложенных патча были интегрированы в мастер на github.

person albert    schedule 03.09.2020
comment
Прошу прощения: я думаю, что у меня последняя версия ecrins-fcazals ›git log -n 1 commit e1d10844790b1f8386eada1ea73960b16e6bc440 (HEAD -› master, origin / master, origin / HEAD) Слияние: 72591fd5 fa32d44f Автор: Dimitri van Doesmail com ›Дата: 3 сентября, 21:19:35 2020 +0200 Запрос на объединение # 7998 из albert-github / feature / issue_7996 issue # 7996 \ ref команды не работают в таблицах уценки Псевдоним обновлен: ALIASES + = sbl_add_package_main_class {4 } = \ addtogroup \ 1-ref-manual ^^ @ {^^ \ class \ 2 ^^ \ short \ 3 \ 4 ^^ @} Но я все равно получаю предупреждение. - person fcazals; 04.09.2020
comment
Вы в курсе основной версии, упомянутые запросы на вытягивание предложены мной и еще не интегрированы в основную версию doxygen. Либо дождитесь, пока они будут интегрированы в основную версию doxygen, либо примените их вручную к своей версии (они маленькие). - person albert; 04.09.2020