2015-03-11 2 views
0

Я создаю тестовый список в Doxygen, используя специальную команду \ test. Я понимаю, что я могу щелкнуть по имени класса для этого раздела и получить доступ к странице, на которой этот тест также находится в ссылке.Выход Полный путь к файлу HTML с Doxygen

Что я хотел бы, однако, в описании теста, чтобы он имел строку, которая является полным пути к файлу.

Есть ли специальная команда для этого? или мне приходится физически вводить его в каждый блок комментариев. ниже я показал пример того, что хочу.

Class myTest 
    Perform a set of tests to verify foo & bar. 
    located in C:\MyFile 

, но я хотел бы написать мой Doxygen комментарий вроде этого:

/** \test 
* Perform a set of tests to verify foo & bar. 
* located in: 
* \fullFilePath 
*/ 

Возможно ли это?

+1

Нет команды \ fullFilePath, есть опция конфигурации FULL_PATH_NAMES и SHOW_USED_FILES, но я думаю они не делают то, что вы хотите. – albert

ответ

1

Выбрав специальные команды, я пришел к выводу, что нет специальной команды Doxygen, чтобы дать результат, как в вопросе.

Doxygen обеспечивает автоматическую гиперссылку на страницы/файлы, которые, как он знает, существуют. Поэтому для «решения» этой проблемы [1] Я добавил минимальное количество путей, которое требуется для создания навигационной ссылки. Это решение выглядит следующим образом:

/** \test 
* Perform a set of tests to verify foo & bar. 
* located in: 
* someFolder/myFile.cpp 
*/ 

Это будет работать на пути к файлу, как: C:/parentFolder/childFolder/someFolder/myFile.cpp


[1] Оригинальный вопрос был сосредоточен вокруг не необходимости вводить путь файла в каждый комментарий блок. Это решение является компромиссом между отсутствием специальной команды и невозможностью записать полный путь к файлу (который иногда может быть очень длинным)

Смежные вопросы