ocaml - 使 ocamlbuild 将 .ml 和 .mli 文件都传递给 ocamldoc

Question

我想在我生成的文档中包含源代码。这在我调用 ocamldoc 时有效在这样的命令行上:ocamldoc -I _build -html -keep-code -colorize-code *.{ml,mli} -d .docdir .但是，我在将其与 ocamlbuild 集成时遇到了麻烦。 .

我在 myocamlbuild.ml 中使用以下代码:

open Ocamlbuild_plugin;;

dispatch begin function
  | After_options ->
      Options.ocamldoc := S[A"ocamldoc"; A"-keep-code"; A"-colorize-code"]
  | _ -> ()
end

但这仅包括没有相应接口(interface)文件的文件的源 - 与所说的相反 here ，看起来像 ocamlbuild拒绝通过 .ml文件到 ocamldoc当有 .mli文件存在。有没有办法哄 ocamlbuild 做我想做的事？

Answer 1

因为我需要破解一些东西来做类似的事情，所以如果我在这里发布它作为答案可能会有所帮助(至少在 OCamlbuild 具有该功能之前)。所以，这是我的 myocamlbuild.ml 的相关部分:

open Ocamlbuild_plugin;;

dispatch begin function
  | After_rules ->
     (* Using both .ml and .mli files to build documentation: *)
     rule "ocaml: ml & mli -> odoc"
       ~insert:`top
       ~tags:["ocaml"; "doc"; "doc_use_interf_n_implem"]
       ~prod:"%.odoc"
       (* "%.cmo" so that cmis of ml dependencies are already built: *)
       ~deps:["%.ml"; "%.mli"; "%.cmo"]
       begin fun env build ->
         let mli = env "%.mli" and ml = env "%.ml" and odoc = env "%.odoc" in
         let tags =
           (Tags.union (tags_of_pathname mli) (tags_of_pathname ml))
           ++"doc_use_interf_n_implem"++"ocaml"++"doc" in
         let include_dirs = Pathname.include_dirs_of (Pathname.dirname ml) in
         let include_flags =
           List.fold_right (fun p acc -> A"-I" :: A p :: acc) include_dirs [] in
         Cmd (S [!Options.ocamldoc; A"-dump"; Px odoc;
                 T (tags++"doc"++"pp"); S (include_flags);
                 A"-intf"; P mli; A"-impl"; P ml])
       end;

    (* Specifying merge options with tags: *)
    pflag ["ocaml"; "doc"; "doc_use_interf_n_implem"] "merge"
      (fun s -> S[A"-m"; A s]);
end

然后添加标签 doc_use_interf_n_implem至 .ml和/或 .mli应该从实现和接口(interface)生成文档的文件应该可以解决问题。

使用上面的代码，添加合并选项也可以通过添加标签来完成，例如 merge(A) (合并所有)。

请注意，这是一个 hack，可能会破坏复杂项目中的内容。值得注意的是，我没有使用 camlp[45] 对其进行测试。 -processed 文件，也不使用 4.00.1 以外的 OCamlbuild 版本。