标签: dartdoc

dartdoc 失败:顶级包需要 Flutter 但未设置 FLUTTER_ROOT 环境变量

我正在尝试为我的颤振包运行 dartdoc,但我得到了这个,

dartdoc failed: Top level package requires Flutter but FLUTTER_ROOT environment variable not set.
Run Code Online (Sandbox Code Playgroud)

如何添加 FLUTTER_ROOT 环境变量,因为我已经为 Flutter SDK 添加了环境变量并且工作正常,我只是在运行时遇到问题dartdoc。我是 Linux 用户。

dart dart-sdk flutter dartdoc

8
推荐指数
2
解决办法
2299
查看次数

如何让 dartdoc 包含其他文档?

我想了解是否有办法在由dartdoc.

根据包布局约定getting_started.mddoc/目录中包含一个文件,显示如下...

enchilada/
  ...
  doc/
    api/ ***
    getting_started.md
Run Code Online (Sandbox Code Playgroud)

该文件如何合并到文档中dartdoc以及它在输出中的何处显示?我试图简单地*.mddoc/目录中添加我自己的文件,但它们似乎没有被使用。

我还在dartdoc文档中阅读了关于类别内容,其中指出:

类别:为每个类别/题目的更多细节。对于您想要记录的主题,使用 markdown: 指定 markdown 文件以用于类别页面。或者,将源代码中的类别重命名为带有“name:”的显示名称。如果 dartdoc_options.yaml 中没有定义匹配的类别,则源代码中声明的类别将不可见。

所以我然后尝试dartdoc_options.yaml像这样引用文件中的其他文档......

dartdoc:
  categories: 
    "Getting Started":
      markdown: doc/getting_started.md

    "Search Filters":
      markdown: doc/search_filters.md


  categoryOrder: ["Getting Started", "Search Filters"]
Run Code Online (Sandbox Code Playgroud)

但这也没有产生任何结果。

有谁知道是否可以包含其他文档以及如何完成此操作?

documentation dart dart-pub dartdoc

7
推荐指数
1
解决办法
367
查看次数

如何在 Dart 和 Flutter 中创建 DartDoc 宏/模板?

我在整个 Flutter 仓库中看到过如下片段:

/// {@macro flutter.widgets.editableText.readOnly}
Run Code Online (Sandbox Code Playgroud)

在 IDE 和渲染的 Dart 文档中,它显示如下

文本是否可以更改。

当此设置为 true 时,文本无法通过任何快捷方式或键盘操作进行修改。文本仍然可以选择。

默认为假。不能为空。

它往往远远超出这个基本情况。

dart flutter dartdoc

6
推荐指数
1
解决办法
423
查看次数

在 dart 文档注释中使用本地图像资源

如何在 dart 文档注释中使用本地资源?当使用基于网络的 url 时,这可以正常工作,如下所示:

/// ![A row of icons representing a pink heart, a green musical note, and a blue umbrella](https://flutter.github.io/assets-for-api-docs/assets/widgets/icon.png)
Run Code Online (Sandbox Code Playgroud)

我想做的是引用我的资产文件夹中的一些图像资产并显示它。像这样的东西:

///![](/assets/some/local/path.png)
///![](/assets/some/other/path.svg)
Run Code Online (Sandbox Code Playgroud)

但我无法获得任何相对的工作路径,这可能吗?

dart flutter dartdoc

5
推荐指数
1
解决办法
694
查看次数

dart 在另一个文件中显示另一个方法的文档

是否可以在不同文件中的另一个函数的文档中显示一个函数的文档?宏仅在其自己的文件中有效。

在Flutter源码中,他们使用了这样的东西,但似乎没有任何效果:

/// {@macro flutter.widgets.editableText.keyboardType}
Run Code Online (Sandbox Code Playgroud)

dart dartdoc

5
推荐指数
1
解决办法
640
查看次数

标签 统计

dart ×5

dartdoc ×5

flutter ×3

dart-pub ×1

dart-sdk ×1

documentation ×1