it-roy-ru.com

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

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

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

Несмотря на это, у меня нет никакой опции в каком-либо меню, чтобы инициировать его.

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

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

22
ruwan.jayaweera

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

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

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

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

16
ruwan.jayaweera

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

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

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

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

    Сайт обновлений является более удобным способом установки eclox. Это Находится по адресу https://anb0s.github.io/eclox . См. Пользователь Eclipse Guilde для дополнительных деталей.

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

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

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

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

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

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

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

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

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

HTH Кто-нибудь

28
siva.p

Я только что столкнулся с проблемой установки двоичного пути Doxygen в настройках eclox 0.8.0 в Eclipse на Mac OS X 10.7 . Нет способа настроить путь с помощью Eclipse-предпочтений -> 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. перезапустите Eclipse
3
klaus

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

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

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

1
MickaelT

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

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

0
goeck

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

0
Yong Yang

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

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

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

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

!!!

0
adrian filipescu

это может помочь вам или любому пользователю 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-install-eclox

0
j2emanue