Являются ли URL-адреса страниц Doxygen постоянными - PullRequest
2 голосов
/ 18 апреля 2011

Привет всем, мы только что добавили ночное действие для обработки всего дерева исходных текстов с помощью doxygen и размещения вывода на веб-сервере разработки.

У нас также уже есть структура sharepoint, в которой хранятся проектные документы для различных модулей / проектов. В настоящее время уровень, на котором мы храним эту документацию, относительно высок. Мы обсуждаем структуры модулей и говорим об основных классах, но никогда не опускаемся до уровня отдельных методов. Я хотел восполнить этот пробел с помощью гиперссылок в текстовых документах SDS, которые указывали бы на вывод кислорода.

Я заметил, что ссылки выглядят так:

http://example.com/docs/ProjectName/d4/d98/class_c_reader.html
http://example.com/docs/ProjectName/d4/d16/class_c_stream.html

Часть, которая выделяет меня немного, это строки "d4", "d98" и "d16" на пути. Если я копирую эти ссылки и создаю гиперссылки, кто-нибудь знает, гарантированно ли эти URL будут сохранены в будущем. Как я уже сказал, весь выход кислорода восстанавливается каждую ночь.

Ответы [ 2 ]

2 голосов
/ 03 мая 2011

Вы можете отключить подкаталоги d4/d98, отключив CREATE_SUBDIRS в конфигурации doxygen.

Останется ли имя файлов HTML таким же, я точно не знаю, но из того, что я видел при использовании doxygen, кажется, что так. Если вы хотите знать наверняка, вы всегда можете посмотреть на источник кислорода.

1 голос
/ 19 апреля 2011

Возможно, эти ссылки не будут постоянными.Кроме того, Doxygen имеет XML-представление сгенерированной документации, но даже этот интерфейс, соответственно.соответствующий DSD был изменен с новыми выпусками doxygen.Это довольно неприятно, так как мы использовали представление XML для аналогичного приложения с предположением, что структуры будут оставаться идентичными с каждым новым выпуском.

...