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

Question

Как мне заставить eclox работать в Eclipse 3.5?

Я использую Ubuntu 9.04. Я установил Doxygen из репозиториев Ubuntu (версия 1.5.8). Затем я установил eclox на eclipse через сайт обновлений.

Несмотря на это, у меня нет возможности включить его в любом меню.

Также на сайте eclox нет руководства по началу работы.

Пожалуйста, помогите.

Answer 1

Кстати, внутри 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.

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

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

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

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

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

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

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

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

HTH Кто угодно

Answer 2

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

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

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

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

Answer 3

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

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

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

Answer 4

Для пользователей 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

Answer 5

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

1. Из меню (... Поиск проекта Выполнить ...)

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

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

!!!

Answer 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.

Answer 7

Как и в случае с Клаусом, мне приходилось копаться в файле настроек вручную, потому что 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

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

Answer 8

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

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

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

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

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

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

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

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

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

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