OCaml Forge

Detail: [#1116] oasis documentation unclear: does Library sections handle ocamldoc? Does XCustomDoc exist?

Bugs: Browse | Download .csv | Monitor

[#1116] oasis documentation unclear: does Library sections handle ocamldoc? Does XCustomDoc exist?

Date:
2012-03-13 14:59
Priority:
3
State:
Open
Submitted by:
Gabriel Scherer (bluestorm)
Assigned to:
Sylvain Le Gall (gildor-admin)
Product:
OASIS
Due in version:
None
Resolution:
None
Severity:
minor
Version:
None
Component:
Website
Operating System:
None
 
URL:
Summary:
oasis documentation unclear: does Library sections handle ocamldoc? Does XCustomDoc exist?

Detailed description
The manual for the Library sections say:

> Define an OCaml library. OCaml API is generated using ocamldoc
> applied to Modules with BuildDepends required flags.

Reading this, I would expect "ocaml setup.ml -doc" to generate ocamldoc for the Modules. However, "ocaml setup.ml -doc" has no effect on my system. Is this a bug? I had to add a specific Document section to get ocamldoc output.



The documentation of the Custom plugin says:

> This plugin allow to define a set of three commands to perform each steps, associated with the following fields:
> XCustomXXX: main action to run.
> XCustomXXXClean: action to run when clean is invoked.
> XCustomXXXDistclean: action to run when distclean is invoked.
> XXX stands for Conf, Build, Doc, Test, Install or Uninstall.

However, XCustomDoc (or XCustomDocClean for that matter) do not seem to exist (... is not defined in schema Package). Can XXX really stand for Doc?

Followup

Message
Date: 2012-10-11 12:14
Sender: Fabian Pijcke

Hello,

I agree that the documentation is quite unclear about the API documentation generation. However, the oasis _oasis file (0.2 version) mentions the following at the end :

Document "api-oasis"
Title: API reference for OASIS
Type: ocamlbuild (0.2)
InstallDir: $htmldir/oasis
BuildTools+: ocamldoc
XOCamlbuildPath: src/
XOCamlbuildLibraries: oasis, oasis.base, oasis.cli

I suppose that this is the correct way to generate documentation. I mention it here because searching for "ocaml oasis ocamldoc" lead us to this bug report.

Attached Files:

Changes:

Field Old Value Date By
assigned_tonone2012-07-06 08:33gildor-admin