我有一个ocamlbuild项目,该项目在子目录中包含一些文件,而.mlpack文件列出了这些文件。
例如我有一个文件support/logging.ml
,它定义了模块Support.Logging
。 _tags
文件说"support": for-pack(Support)
。
这一切都建立并运行良好。但是如何使用ocamldoc生成此文档?
我发现的最新帖子是2011年的ocamldoc generation and packed files,它建议使用ocp-pack
生成一个大的.ml文件并将其传递给ocamldoc
。但是,这没有考虑到构建顺序,因此由于正向引用,生成的模块无法正常工作。
处理此问题的最佳方法是什么?
最佳答案
该问题在the following bugreport中进行了描述。在ocamldoc中处理-pack
需要付出维护人员不愿意执行的实现工作,到目前为止,没有人加紧为该功能提供补丁。
同时,您可以轻松地将foo.mlpack
文件复制到foo.odocl
中,生成单独的子模块的文档。这只是一个不完善的解决方法,因为该文档将谈论X
而不是Foo.X
,但这是最省力的解决方案。