如何告诉dartdoc记录所有内容?

时间:2012-12-25 10:58:06

标签: dart

我试图将我的类分别放在一个文件中,这些类属于几个不同的库。

基本上,这些文件的顶部有library inf.logic;

  • web/logic/realm.dart(导入region.dart
  • web/logic/region.dart(导入../events.dart
  • web/logic/tile.dart

这有library inf.gfx;

  • web/gfx/viewport.dart(导入../logic/realm.dart

这只是library inf;

  • web/events.dart

然后我有了主要入口点,默认情况下似乎最终会出现在inf库中:

  • web/inf.dart(导入gfx/viewport.dartlogic/realm.dartlogic/region.dartlogic/tile.dart

当我生成dartdoc时,它似乎只能抓住一些类,看似随机。即使主入口点明确使用了上述所有类,我也只会为region.dartevents.dart生成文档。没有包含其他文件,并且文档中引用其他类的链接导致404。

感觉我做错了什么。我是否应该为库创建包装文件并使用partpart of?我真的不喜欢在文件关系之间添加维护需求的想法,这应该已经隐含在导入中了。

另外,我怎样才能摆脱相对路径?我试过了package:inf/logic/realm.dart,但它不起作用......

1 个答案:

答案 0 :(得分:0)

Andrei Mouravski在邮件列表上回答了这个问题:

这里有几个问题:

  1. 如果Dartdoc正在生成404链接,那么请提供您可能提供的所有信息的错误。事情有可能破裂。 dartbug.com/new

  2. 您可以通过传递多个入口点同时记录多个内容。注意:如果您有多个入口点,则应使用'pkg'命令行选项指定packages文件夹。

  3. 您不需要包装器文件,但dartdoc应该记录在入口点中导入的每个库,因此可能只需要一个简单的文件来导入您想要记录的所有库。我们正在为此做更好的事情,对不起,此刻有点破碎。