Doxygen Markdown Ссылки на главную страницу не работают - PullRequest
Новая
       48

Doxygen Markdown Ссылки на главную страницу не работают

0 голосов
/ 10 января 2020

Я создаю документацию с использованием Doxygen 1.8.17, в которой есть несколько страниц обзора, написанных на Markdown. Для этого я создаю главную страницу и несколько других страниц, которые будут содержать ссылки между собой, как показано в этом посте и в документации по doxygen.

Моя проблема в том, что ссылки с других страниц на главную страницу (README.md) не работают , в то время как ссылки с главной страницы на другие страницы работают и ссылки между другими страницами работают.

Я скомпилировал Пример использования докси-файла defauld (doxygen -g, за которым следует doxygen Doxyfile). Во время компиляции doxygen жалуется на неразрешенные ссылки (DoxyMinimalExample/otherpage.md:6: warning: unable to resolve reference to 'mainpage' for \ref command)

Ссылка на README.md не работает. Как мне создать ссылку на главную страницу? Как правильно назвать команду \ ref?

Минимальный пример (все файлы в одной папке): README.md 

# The Main Page {#mainpage}
My Main Page
============

Documentation that will appear on the main page

1. See [the other page](@ref otherpage) for more info.
2. or see @ref md_otherpage for more info.

or
1. See [the third page](@ref thirdpage) for more info.

otherpage.md 

# The Other Page {#otherpage}
My other page
============

More detailed Info
1. See [the main page](@ref mainpage) for an overview.
2. See [the main page](@ref #mainpage) for an overview.
3. See [the main page](@ref #README) for an overview.
4. See [the main page](@ref README) for an overview.
5. See [the main page](@ref README.md) for an overview.
6. See [the main page](README.md) for an overview.
7. See [the main page](@ref md_README) for an overview.
8. See [the main page](@ref md_mainpage) for an overview.
9. See [the main page](md_README) for an overview.
10. See [the main page](md_mainpage) for an overview.
11. See @ref mainpage for an overview.
12. See [the main page](@ref md_README.md) for an overview.
13. See @ref md_README for an overview.
14. See @ref md_README.md for an overview.

or
1. See [the third page](@ref thirdpage) for other info

thirdpage.md 

# The Third Page {#thirdpage}
My third page
============

More detailed Info
1. See [the other page](@ref otherpage) for other info

1 Ответ

0 голосов
/ 14 января 2020

Немного странно, что на страницу с якорем {#mainpage} нельзя ссылаться в doxygen, и нужно использовать 'index' в качестве ссылки.

Я только что отправил предложенный патч на github (pull запрос 7511, https://github.com/doxygen/doxygen/pull/7511) для решения этой проблемы.

РЕДАКТИРОВАТЬ: код запроса на извлечение был интегрирован в master на github

...