Пользовательские теги с Doxygen

Спасибо, mouviciel! Я принял doxygen ваше решение и расширил его doxygen для своих целей.

Текст ниже doxygen входит в мой Doxyfile:

ALIASES += req{1}="\ref SRTX_\1 \"SRTX-\1\" "
ALIASES += satisfy{1}="\xrefitem satisfy \"Satisfies requirement\" \"Requirement Implementation\" \1"
ALIASES += verify{1}="\xrefitem verify \"Verifies requirement\" \"Requirement Verification\" \1"

Где doxygen SRTX - это имя моего проекта, которое doxygen используется в качестве префикса doxygen к требованиям.

Затем я создаю doxygen файл под названием Requirements.dox, который doxygen обеспечивает связь между doxygen идентификатором требования doxygen и URL-адресом требования doxygen в моем инструменте управления doxygen требованиями (в моем случае doxygen это средство отслеживания doxygen проблем).

/**
@page Requirements

@section Build1

@anchor SRTX_1113
SRTX-1113

@anchor SRTX_1114
SRTX-1114

*/

Можно также поместить doxygen текст требования в тег привязки, если doxygen вам не нужно ссылаться на doxygen внешний источник.

В моем коде doxygen есть:

/**
 * This is the basic executive that schedules processes.
 * @satisfy{@req{1114}}
 */
class Scheduler: public Process
{
    ...
}

И в своих тестах я поставил:

/**
 * Provide a number of tests for process scheduling.
 * @verify{@req{1114}}
 */
class Scheduler_ut : public CppUnit::TestFixture
{
    ...
}

Это doxygen дает мне страницы, посвященные doxygen требованиям, выполнению требований doxygen и проверке требований. Он doxygen также предоставляет разделы doxygen "Удовлетворяет требованиям" и doxygen "Проверяет требования" в doxygen описании класса (или функции doxygen - где бы вы ни поместили doxygen тег).

doxygen

2022-11-16T22:25:24+00:00