Doxygen @ link to URL неправильно генерирует ссылку - PullRequest
22 голосов
/ 01 февраля 2012

Я добавил это к комментарию класса:

@link http://www.google.com Google @endlink

Однако, когда я генерирую документацию с использованием doxygen, текст ссылки действительно "Google", но ссылка на:

file: ///media/portable/Examples/Doxygen/link/html/classClass1.html

Может кто-нибудь объяснить, что идет не так?

1 Ответ

33 голосов
/ 01 февраля 2012

Я думаю, что вы используете \link неправильно.Из документации doxygen , \link используется для ссылки на объекты, такие как файл, класс или член, и принимает ссылку на один из них в качестве первого аргумента.Например, если бы я хотел сослаться на метод класса func в классе myClass, я бы использовал

\link myClass::func link text ... \endlink

со всеми оставшимися аргументами, которые считаются текстом для ссылки.Я думаю, что ваша проблема в том, что вы не передаете действительный объект в качестве первого аргумента.Я бы предположил, что classClass1 - это следующий объект в файле, в который вы пытались включить ссылку, и это то, на что ссылается команда \link.

Ссылка на URL

Doxygen автоматически генерирует URL-ссылки, поэтому нет необходимости заключать ссылку в \link и \endlink или любые другие команды.Поэтому удалите их и посмотрите, решит ли это проблему.

Чтобы вручную указать текст ссылки, используйте HTML-тег 'a':

<a href="linkURL">link text</a> 

Для получения дополнительной информации о том, как doxygen обрабатывает автоматические ссылки см. Эту страницу документации.

...