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

Ответ 1

Не обращай внимания, отработал сам.

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

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

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

Ответ 2

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

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

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

• Установка

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

  Сайт обновления - это более удобный способ установки eclox. это расположенный в https://anb0s.github.io/eclox. Просмотреть пользователя eclipse гильдия для дополнительной информации.

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

• КОНФИГУРАЦИЯ

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

• ИСПОЛЬЗОВАНИЕ

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

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

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

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

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

HTH Кто-нибудь

Ответ 3

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

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

• добавьте (фальшивое) местоположение, скажем /Applications, используя мастер, упомянутый выше.
• закрыть Eclipse
• отредактируйте этот файл: $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.
• перезапустить Eclipse

Ответ 4

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

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

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

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

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

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

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

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

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

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

Ответ 5

Как и claus, мне приходилось копаться в файле предпочтений, потому что eclox 0.8.0 просто не удастся найти хороший путь от выбора файла Eclipse Preferences. Итак, отредактируйте этот файл: $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

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

Ответ 6

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

Ответ 7

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

• Из меню (... Поиск проекта выполняется...)

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

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

!!!

Ответ 8

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

После установки подключения Eclox:

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