Как использовать eclox, плагин doxygen для Eclipse

Кстати, внутри org.gna.eclox_0.8.0.jar есть руководство, странно, что они не разместили его на сайте проекта!!!

Вот содержание

      Eclox, a Doxygen frontend plugin for Eclipse.
            <http://gna.org/projects/eclox>

1. УСТАНОВКА

   Существует два варианта установки плагина: с помощью сайта обновлений или с помощью пакетной функции.

   Сайт обновлений — более удобный способ установки eclox. Он находится по адресу https://anb0s.github.io/eclox. Дополнительную информацию см. в гильдии пользователя eclipse.

   При использовании упакованной функции вы должны извлечь содержимое архива в корневую папку вашего eclipse. Дополнительные сведения см. в руководстве пользователя eclipse.

2. КОНФИГУРАЦИЯ

   После установки плагина вы должны убедиться, что переменная среды PATH по умолчанию делает двоичный файл doxygen доступным для плагина. Если нет, вы можете обновить PATH, чтобы включить его в каталог, содержащий двоичный файл Doxygen, или вы можете указать Eclox, где этот двоичный файл находится в вашей системе (что, на мой взгляд, является лучшим решением). Для этого откройте диалоговое окно редактирования настроек eclipse и перейдите в новый раздел «Doxygen».

3. ИСПОЛЬЗОВАНИЕ

   Вы можете создавать новые проекты Doxygen (также называемые doxyfiles) с помощью мастера создания. Перейдите в «Файл-> Создать-> Другое-> Другое-> Конфигурация Doxygen». Нажмите «Далее» и задайте местоположение и имя файла. Затем в указанном месте будет создан пустой doxyfile, мастер автоматически добавит расширение «.Doxyfile».

   Теперь вы должны увидеть файл с синим значком @. Это ваш новый доксифайл. Двойной щелчок по нему откроет редактор. Теперь вы можете просматривать и редактировать настройки.

   После того, как вы правильно настроите все поля doxyfile, вы можете запустить сборку документации, используя значок на панели инструментов с синим знаком @. В случае, если кнопка не отображается на панели инструментов, ваша текущая перспектива должна быть настроена. Перейдите в «Окно-> Настроить перспективу-> Команды» и в «Доступных группах команд» отметьте «Doxygen». Кроме того, вы можете просмотреть последние сборки, щелкнув стрелку вниз справа от кнопки на панели инструментов.

   Когда начинается сборка документации, открывается новое представление с журналом сборки. На его панели инструментов кнопка «Стоп» позволяет остановить текущий процесс сборки. Текущая сборка также отображается в представлении хода выполнения задания Eclipse, и оттуда можно управлять заданием.

   Действие панели инструментов сборки определяет следующий доксифайл для сборки в зависимости от текущей активной части рабочей среды (редактор или представление) и текущего выбора в этой части. Например, если активной частью является редактор doxyfile, следующим doxyfile для сборки будет редактируемый. Если активной частью является обозреватель ресурсов, а текущим выбором является доксифайл, этот доксифайл будет следующим для сборки. В случае, если выбор активной части не соответствует доксифайлу, будет перестроен последний построенный доксифайл. И если история сборки пуста, вам будет предложено построить doxyfile.

HTH Кто-нибудь

Ничего, разобрался сам.

Сначала вам нужно создать DoxyFile (файл конфигурации), указав исходный и выходной пути.

Только тогда вы можете создать документацию, щелкнув правой кнопкой мыши проект и выбрав «Создать документацию».

Спасибо, в любом случае!

Я только что столкнулся с проблемой установки бинарного пути Doxygen в настройках eclox 0.8.0 в Eclipse на Mac OS X 10.7. Невозможно настроить путь через Eclipse-preferences->Doxygen.

Решение состоит в том, чтобы отредактировать файл настроек вручную

1. добавьте (поддельное) местоположение, скажем, /Applications, используя упомянутый выше мастер.
2. закрыть затмение
3. отредактируйте этот файл: $WORKSPACE/.metadata/.plugins/org.eclipse.core.runtime/.settings/org.gna.eclox.core.prefs: замените значение для doxygen.default (в настоящее время eclox.core.doxygen.CustomDoxygen /Applications\n) на eclox.core.doxygen.CustomDoxygen /Applications/Doxygen.app/Contents/Resources/doxygen\n.
4. перезапустить затмение

Для пользователя MacOS есть очень простой способ обойти проблему выбора версии Doxygen. Ссылка с подробной информацией находится здесь: https://github.com/theolind/mahm3lib/wiki/Integrating-Doxygen-with-Eclipse

После установки заглушки Eclox:

1) "перейдите в "Eclipse --> Настройки --> Oxygen" 2) "Нажмите Shift+CMD+G, затем добавьте: "/Applications/Doxygen.app/Contents/Resources/doxygen" 3) Версия Doxygen должна отображаться

это может помочь вам или любому пользователю Windows, пытающемуся установить eclox:

Учебное пособие по установке eclox — стенограмма документа

Шаг 1: перейдите на веб-сайт eclox (http://home.gna.org/eclox/) и чтобы скопировать адрес ссылки обновления. Шаг

шаг 2: Вставьте ссылку в менеджер обновлений в eclipse и нажмите OK.

Шаг 3: Выберите элемент Eclox и завершите установку.

Шаг 4: Когда установка завершена, вы должны выбрать проект, который вы хотите создать документы doxygen. Затем создайте для него проект doxygen.

Шаг 5: настройте параметры. Примечание. Вы должны правильно указать «Входные каталоги» и выбрать пункт «Сканировать рекурсивно». Наконец, сохраните файл конфигурации.

Шаг 6: найдите «@» и выберите «Выбрать Doxyfile...».

Шаг 7: выберите doxyfile. Шаг 8: подождите несколько секунд, и документы будут сгенерированы.

по этой ссылке: http://www.slideshare.net/pickerweng/tutorial-for-installing-eclox

Как и Клаусу, мне пришлось копаться в файле настроек вручную, потому что eclox 0.8.0 просто не выбрал бы правильный путь от средства выбора файла настроек Eclipse. Итак, отредактируйте этот файл: $WORKSPACE/.metadata/.plugins/org.eclipse.core.runtime/.settings/org.gna.eclox.core.prefs и измените указанный путь (в моем случае мне пришлось перейти с

doxygen.default=eclox.core.doxygen.CustomDoxygen C\:\\Programm Files\\doxygen\\bin

к этому

doxygen.default=eclox.core.doxygen.CustomDoxygen C\:\\Programme\\doxygen\\bin

Надеюсь это поможет.

Я нашел веб-страницу https://github.com/theolind/mahm3lib/wiki/Integrating-Doxygen-with-Eclipse, где вы можете найти более подробную информацию. В частности, пользователям Mac необходимо нажать Shift+CMD+G, а затем добавить: "/Applications/Doxygen.app/Contents/Resources/doxygen" при настройке doxygen в eclipse перед компиляцией .doxygfile. с помощью Эклокса.

Альтернативой eclipse является использование Javadoc:

1. Из меню (...Поиск запуска проекта...)

Проект > Создать Javadoc

2. Вы должны быть в проекте Java и добавлять комментарии с тегами.

!!!