Я пытаюсь сгенерировать исходную документацию OpenFOAM 1.7.1 с использованием doxygen 1.6.3 и Doxyfile, который поставляется с источником OpenFOAM. К сожалению, некоторые вещи, очевидно, пошло не так во время компиляции:Doxygen: ошибки при компиляции документации OpenFOAM 1.7.1
All
,Classes
,Namespaces
и т.д. ссылки, которые должны отображаться на главной странице не работают. Ничего не происходит, когда я нажимаю на них.- Когда я перехожу к классу с помощью вкладок, как диаграмма наследования, так и диаграмма сотрудничества показывают только сам класс, ничто другое - даже в тех случаях, когда я знаю, что эти диаграммы довольно большие.
- Поиск не работает. Когда я ввожу что-то в поле поиска и нажимаю Enter, ничего не происходит.
Я посмотрел на выход doxygen run и, пока он выдал много предупреждений, я не получил сообщений об ошибках. Он жаловался:
- не совпадающих элементов файлов для классов, операторов и функций, не членов сопоставления класса, членов не однозначно согласующего класса,
- документированных но незаявленных или неопределенных функций,
- Неподдержанного XML/HTML тег
<cloudname>
, - много блоков:
</li>
тег без согласования<li>
</ul>
тег без согласования<ul>
неожиданный конец комментария в то время как внутри<ul>
блока
Может это, возможно, испортили поиск? Я не могу редактировать все файлы, чтобы избавиться от предупреждений, их слишком много.
Я изменил Doxyfile, поставляемый с OpenFOAM, установив расширение выходного файла на html
(был php
раньше) и добавив строку SERVER_BASED_SEARCH = NO
, но это ничего не изменило. Я сделал это, потому что шаблон Doxyfile, используемый разработчиками OpenFOAM, предназначен для doxygen 1.5.3 (это то, что он говорит в первой строке), и насколько я знаю, дополнительный вариант поиска пришел с 1.6.2.
Что здесь могло быть не так? По-видимому, разработчикам OpenFOAM удалось создать документы раньше, они уже не в сети.
Если у кого есть ссылка на скомпилированные онлайн-документы для OF-1.7.1, я с удовольствием их использую - я просто не нашел ничего, кроме самой последней версии.
Я нашел руководство по использованию Doxygen связанных файлов (конфигурации, заголовок, ...) из OF-2.0.0 для создания документации OF-1.7.1, с помощью Doxygen 1.7.5.1 здесь : http://www.cfd-online.com/Forums/openfoam/78529-building-openfoam1-7-0-source-2.html
Я использовал doxygen 1.7.6.1 вместо (загружал неправильную версию и просто попытался его с этим), и в Doxyfile:
INPUT_FILTER = doxyFilt
FILTER_SOURCE_FILES = YES
SHORT_NAMES = NO
теперь у меня есть все вкладки и поиск рабочего Javascript, и все диаграммы, кажется, полный.
Я загрузил doxygen 1.5.3 и использовал его для создания документации, но не повезло. 'doxyFilt' находится на пути. Как вы сказали, вкладки в порядке - но поиск все еще сломан, а диаграммы наследования и совместной работы пока показывают только класс, для которого они были созданы. – Christoph
Я только узнал, что поиск на основе Javascript был введен с doxygen 1.6.0, поэтому я не могу выполнять локально выполняемый поиск, когда создаю документацию с помощью doxygen 1.5.3. – Christoph
В прошлом у меня были проблемы с Doxygen, потому что его сканер/парсер не совсем справился с этой задачей. Следовательно, разные верности ведут себя по-разному в одном и том же исходном коде, иногда даже жалуются, когда нет никакой проблемы. Поэтому переключение версий Doxygen - это, вероятно, путь. – Raedwald