caml-list - the Caml user's mailing list
 help / color / mirror / Atom feed
From: "Soegtrop, Michael" <michael.soegtrop@intel.com>
To: "caml-list@inria.fr" <caml-list@inria.fr>
Subject: [Caml-list] Ocamldoc ignores section header special comments
Date: Wed, 6 Jul 2016 09:21:22 +0000	[thread overview]
Message-ID: <0F7D3B1B3C4B894D824F5B822E3E5A172CF1F269@IRSMSX102.ger.corp.intel.com> (raw)

[-- Attachment #1: Type: text/plain, Size: 986 bytes --]

Dear OCaml Users,

I started to use ocamldoc (via ocamlbuild doc.docdir/index.html). It works as expected, just it ignores all section headers (they don't appear in the generated HTML at all). I wonder what I am doing wrong here.

The syntax I am using is

(** {2 Lexer utilities} *)

One thing I didn't fully understand from the documentation is if ocamldoc generates one HTML file per module or one per ML file or both (I don't have explicit modules as yet) and how section headers are interpreted in this context. If I have more than one module in a file, do the section headers belong to the module, or the ML file or both?

Best regards,

Michael
Intel Deutschland GmbH
Registered Address: Am Campeon 10-12, 85579 Neubiberg, Germany
Tel: +49 89 99 8853-0, www.intel.de
Managing Directors: Christin Eisenschmid, Christian Lamprechter
Chairperson of the Supervisory Board: Nicole Lau
Registered Office: Munich
Commercial Register: Amtsgericht Muenchen HRB 186928

[-- Attachment #2: Type: text/html, Size: 3198 bytes --]

             reply	other threads:[~2016-07-06  9:21 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-07-06  9:21 Soegtrop, Michael [this message]
2016-07-06  9:29 ` Daniel Bünzli
2016-07-06  9:44   ` Soegtrop, Michael

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=0F7D3B1B3C4B894D824F5B822E3E5A172CF1F269@IRSMSX102.ger.corp.intel.com \
    --to=michael.soegtrop@intel.com \
    --cc=caml-list@inria.fr \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).