Doxygen: ошибки при компиляции документации OpenFOAM 1.7.1 - PullRequest
Новая
       6

Doxygen: ошибки при компиляции документации OpenFOAM 1.7.1

0 голосов
/ 05 января 2012

Я пытаюсь сгенерировать исходную документацию OpenFOAM 1.7.1, используя doxygen 1.6.3 и Doxyfile, поставляемый с источником OpenFOAM. К сожалению, некоторые вещи явно пошли не так во время компиляции:

  • ссылки All, Classes, Namespaces и т. Д., Которые должны отображаться на главной странице, не работают. Ничего не происходит, когда я нажимаю на них.
  • Когда я перехожу к классу с помощью вкладок, и диаграмма наследования, и диаграмма сотрудничества показывают только сам класс, и ничего больше - даже в тех случаях, когда я знаю, что эти диаграммы довольно большие.
  • Поиск не работает. Когда я что-то набираю в окне поиска и нажимаю Enter, ничего не происходит.

Я посмотрел на вывод прогона doxygen, и хотя он выдал много предупреждений, я не получил сообщений об ошибках. Жаловался на:

  • нет соответствующих членов файла для классов, операторов и функций, нет соответствующих членов класса, нет однозначно совпадающих членов класса,
  • документированные, но необъявленные или неопределенные функции,
  • Неподдерживаемый тег xml / html <cloudname>,
  • много блоков:
    </li> тег без соответствия <li>
    </ul> тег без соответствия <ul>
    неожиданный конец комментария внутри <ul> блока

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

Я изменил Doxy-файл, поставляемый с OpenFOAM, установив расширение выходного файла на html (раньше было php) и добавив строку SERVER_BASED_SEARCH = NO, но это ничего не изменило. Я сделал это, потому что шаблон Doxyfile, который использовали разработчики OpenFOAM, предназначен для doxygen 1.5.3 (это то, что написано в первой строке), и, насколько я знаю, дополнительная опция поиска появилась в 1.6.2.

Что здесь могло пойти не так? Разработчики OpenFOAM, похоже, раньше успешно создавали документы, просто их больше нет в сети.

Если у кого-нибудь есть ссылка на скомпилированные онлайн-документы для OF-1.7.1, я с радостью воспользуюсь ими - я просто не нашел ничего, кроме самой последней версии.

Я нашел руководство по использованию связанных с doxygen файлов (config, header, ...) OF-2.0.0 для создания документации OF-1.7.1 с использованием doxygen 1.7.5.1 здесь: http://www.cfd -online.com / Форум / OpenFOAM / 78529-здание-openfoam1-7-0-источник-2.html

Вместо этого я использовал doxygen 1.7.6.1 (скачал не ту версию и только что попробовал с этим), а в файле doxy:
INPUT_FILTER = doxyFilt
FILTER_SOURCE_FILES = YES
SHORT_NAMES = NO

Теперь у меня есть все вкладки и работает поиск по Javascript, и все диаграммы кажутся законченными.

1 Ответ

2 голосов
/ 06 января 2012

Я не слишком знаком с OpenFOAM, но вы можете попробовать:

  • Использовать Doxygen 1.5.3 вместо Doxygen 1.6.3.Поскольку в их файлах упоминается 1.5.3, он, вероятно, будет более совместим с их источником (и служебными скриптами).
  • Убедитесь, что на вашем пути есть doxyFilt: $WM_PROJECT_DIR/bin.Этот сценарий вызывается doxygen и будет обрабатывать исходные файлы до того, как они будут использованы Doxygen.

С помощью вышеизложенного я смог убедиться, что Classes, Namespace и связанные вкладки работалиправильно.

Вам также может понадобиться взглянуть на служебные скрипты, расположенные по адресу $WM_PROJECT_DIR/doc/Doxygen/tools, так как они, по-видимому, связаны с выявлением проблем и исправлением сгенерированной документации.

...