Добавление новой пользовательской вкладки в макете doxygen

Question

Я новичок в использовании Doxygen 1.8.7. Я пытаюсь добавить диаграмму архитектуры, чтобы быть частью документации API, сгенерированной для моего проекта C# с использованием doxygen. Я сгенерировал файл макета doxygen по умолчанию (DoxygenLayout.xml) и отредактировал его, добавив следующие изменения:

<navindex>
    <tab type="mainpage" visible="yes" title="">
        <tab type="mainpage" visible="yes" title="Audience" />
        <tab type="user" url="@ref Architecture" title="My Page" />
    </tab>
    <tab type="pages" visible="yes" title="" intro=""/>
    <tab type="modules" visible="yes" title="" intro=""/>
    <tab type="namespaces" visible="yes" title="">
      <tab type="namespacelist" visible="yes" title="" intro=""/>
      <tab type="namespacemembers" visible="yes" title="" intro=""/>
    </tab>
    <tab type="classes" visible="yes" title="">
      <tab type="classlist" visible="yes" title="" intro=""/>
      <tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/> 
      <tab type="hierarchy" visible="yes" title="" intro=""/>
      <tab type="classmembers" visible="yes" title="" intro=""/>
    </tab>
    <tab type="files" visible="yes" title="">
      <tab type="filelist" visible="yes" title="" intro=""/>
      <tab type="globals" visible="yes" title="" intro=""/>
    </tab>
    <tab type="examples" visible="yes" title="" intro=""/>  

  </navindex>

Диаграмма архитектуры является внешним документом и не генерируется при запуске doxygen. Итак, мой вопрос - куда я могу поместить этот архитектурный документ? Или это должно быть частью проектного решения.

Answer 1

Это очень просто сделать. Вы уже сделали сложную часть, создав DoxygenLayout.xml файл. Теперь вам просто нужно добавить пользовательскую вкладку:

<tab type="user" url="architecture.html" title="Architecture"/>

Вы можете поместить это где угодно под <navindex> тег. В целях тестирования вы можете просто добавить его в самый конец группы.

title Атрибут может быть любой текстовой строкой, которую вы хотите.

url Атрибут может быть URL-адрес любого файла, который вы хотите. Конечно, это не обязательно должен быть файл HTML. Это может быть PDF, Word DOC или любой другой. Вы также можете использовать "@ref mypage" сделать ссылку на страницу Doxygen с именем mypage ( подробности см. в документации).

Answer 2

С помощью следующей команды создается документ DoxygenLayout.xml по умолчанию :

      doxygen -l 

Следующим шагом является упоминание файла макета в файле конфигурации:

LAYOUT_FILE = DoxygenLayout.xml

Графический интерфейс Doxygen 1.8.20