File: doc.mli

package info (click to toggle)
ocaml-obuild 0.2.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,456 kB
  • sloc: ml: 14,491; sh: 211; ansic: 34; makefile: 11
file content (11 lines) | stat: -rw-r--r-- 356 bytes parent folder | download 
1
2
3
4
5
6
7
8
9
10
11
 
(** Documentation generation *)

exception DocumentationBuildingFailed of string
(** Raised when documentation building fails with an error message *)

val run : Project.t -> unit
(** [run proj_file] generates documentation for the project.

    Currently a stub implementation.

    @raise DocumentationBuildingFailed if documentation generation fails *)