Documentation Refactoring Toolkit -- инструмент поиска клонов и рефакторинга документации в рамках проекта DocLine.
Documentation Refactoring Toolkit -- легковесный инструмент, который можно
запускать (стартовый файл -- element_miner_ui.py
) прямо из рабочего каталога
репозитория без полноценного развёртывания DocLine. Системные требования
инструмента достаточно простые, см. раздел "Требования" ниже.
После запуска будет показано окно настройки поиска клонов в документации.
Пользователь может выбрать:
- минимальную длину искомых клонов
- способ проверки и восстановления нарушений XML-разметки
- дополнительные опции поиска клонов:
- разрешать/запрещать пересечения клонов
- ограничивать (и чем) дисперсию размера вариативного фрагмента при поиске клонов с точкой расширения
- отфильтровывать бессмысленные клоны, состоящие из языковых оборотов
- исходный DRL-файл для анализа
После нажатия кнопки "OK" инструмент какое-то время будет работать, после чего
предложит список кандидатов на создание информационных элементов и элементов
словаря DRL. При запуске из DocLine (Eclipse) результаты рефакторинга
будут сохранены в исходном файле, для которого рефакторинг был запущен.
При отдельном запуске -- в файл с именем
<исходный файл>.reformatterd.refactored
.
В каталоге tests/documentation
содержится документация ряда проектов с
открытым исходным кодом. Для удобства анализа документация каждого проекта
собрана в один XML-файл, по одному файлу на проект.
- Python 3.4.x
- PyQt5 5.5.x
- LXML
- PyContracts --
pip install PyContracts
- pygments --
pip install pygments
- NumPy --
pip install NumPy
- intervaltree --
pip install intervaltree
Версии пакетов -- любые актуальные, совместимые с Python 3.4
- Компьютер архитектуры
x86
илиx86_64
для запуска Clone Miner, Windows или UN*X - для Windows:
- .NET Framework 4.5 для запуска Fuzzy Finder
- для UN*X-подобных систем:
Исходные тексты, в которых используется PyQT, лицензированы под GPL v3. Документация в тестах лицензирована в соответствии с лицензиями её исходных материалов. Остальные тексты и исходные коды лицензированы под LGPL v3.
При помощи build_dist/dcm_pack_windows.sh
можно создать самораспаковывающийся архив.
Сценарий предназначен для работы в Windows, настройки находятся прямо в нём.
Для получения Portable-дистрибутива обращайтесь к нам.