(Windows) `dartdoc` генерирует файлы документации для каждой базовой библиотеки в SDK Dart и Flutter при работе с моим (крошечным) пакетом

Question

Первая проблема, с которой я столкнулся - и которая, я думаю, связана с основной, - связана с переменной FLUTTER_ROOT.

Я не знаю, почему это не было предустановлено в какой-то момент установки, но, в любом случае, я просто не могу установить его из VS Code, даже если я открываю его с администратором разрешения.

Если я запускаю dartdoc в VS Code, я получаю следующую ошибку:

Documenting <package_name>...

dartdoc failed: Top level package requires Flutter but FLUTTER_ROOT environment variable not set.

Мои конфигурации:

• Моя папка верхнего уровня bin для Флаттер расположен на C:\src\flutter\flutter.
• Моя переменная среды FLUTTER_ROOT имеет значение C:\src\flutter\flutter как для моего пользователя, так и для системы.

Если я запускаю ее с разрешениями в Powershell или командной строке, она анализирует каждый базовая библиотека dart (dart-async, dart-collection, dart-core, et c.) и каждая базовая библиотека Flutter, которую, как мне кажется, понятно, генерирует документы моей библиотеки , но затем она также генерирует документы для всех этих основных библиотек дротиков. Это предполагаемое поведение?

Answer 1

Я до сих пор не знаю, почему это происходит или это было задумано, но одна вещь, которая сработала для меня:

dartdoc --include <library_name>

Это позволит убедиться, что только ваш пакет включен в документы и не его зависимости. От dartdoc --help:

--include: имена библиотек для создания документов.

Просто перезапустите dhttpd:

dhttpd --path doc/api

Это все еще не объясняет проблему, с которой я столкнулся с переменной среды FLUTTER_ROOT (Windows).