Попытка объединить несколько файлов README.md в Doxygen Dump - PullRequest
Новая
       125

Попытка объединить несколько файлов README.md в Doxygen Dump

0 голосов
/ 31 мая 2018

Я не вижу ответа на этот вопрос выше, поэтому вот мой вопрос:

У меня есть набор проектов.Они выражаются как вложенные подмодули Git, например: 

MAIN-PROJECT
    LIBRARY-1
        LIBRARY-2
            ETC.

Каждый подмодуль имеет файл README.md и файл CHANGELOG.md (стандартная модель GitHub): 

MAIN-PROJECT
    README.md
    CHANGELOG.md
    LIBRARY-1
        README.md
        CHANGELOG.md
        LIBRARY-2
            README.md
            CHANGELOG.md
            ETC.

Что яхочу сделать, это использовать «Root» README в качестве главной страницы в дампе, но по-прежнему отображать внутренние README, так как у каждого есть хорошая информация.

Я не хочу индивидуально создавать каждый дамп кислорода.Я хочу иметь одну, монолитную свалку, которая начинается в «Корне».Это потому, что я хочу, чтобы классы и тому подобное связывались.

Есть ли способ сделать это?Я попытался указать README «Root» явно, но похоже, что вы можете указать только имя файла, а не путь.Это означает, что КАЖДЫЙ ЧТЕНИЕ рассматривается для этой должности, а тот, который выигрывает, является «самым глубоким».

1 Ответ

0 голосов
/ 01 июня 2018

Чтобы иметь возможность использовать несколько файлов 'README.md', необходимо принять во внимание несколько вещей:

  • указать основной README.md с относительным путем при использовании USE_MDFILE_AS_MAINPAGE.
  • альтернативно используйте \mainpage в мастере 'README.md'
  • используйте \page в другом 'README.md', чтобы можно было различать разные файлы.

Обратите внимание также на возможности \subpage и \ref ссылаться на другие страницы

...