Haxe文档XML:如何排除标准库?

时间:2014-07-06 04:21:51

标签: xml documentation haxe documentation-generation rtti

我想在Haxe中制作一个小工具来检查haxedoc的评论。我认为获得这些评论的最好方法是使用" haxe -xml"选项,并在生成的XML文件中加载。

但是,当我生成XML时,似乎在输出XML中包含了整个标准库。当我将此XML传递给Dox时,它会为我的代码生成标准库内容的文档,例如: Class,Date,String,Enum ......

这是预期的行为吗?有没有办法从生成的XML中排除标准库条目?或者我应该编写我的工具来过滤基于package / filename / etc的XML吗?

这是我的构建脚本:

/build.hxml

-cp src
-neko main.n
--no-output
-xml bin/xml/neko.xml
--macro "include('doctest')"

这是我要为其生成XML的文件:

/src/doctest/Main.hx

package doctest;

//import neko.Lib;

/**
 * ...
 * @author jjokin
 */
class Main 
{
    static function main() 
    {
    }
}

/**
 * This class does some stuff.
 */
class DemoClass {
}

1 个答案:

答案 0 :(得分:2)

好的,我想我已经解决了。编译后的XML必须始终包含所有内容 - 例如Array,Enum,Class,List - 因为这些是编译到其他语言所必需的。我看过Dox,它有“-in / - include”和“-ex / - exclude”选项,可以过滤元素来生成文档。所以,我的模块需要做类似的事情。