From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Original-To: caml-list@sympa.inria.fr Delivered-To: caml-list@sympa.inria.fr Received: from mail2-relais-roc.national.inria.fr (mail2-relais-roc.national.inria.fr [192.134.164.83]) by sympa.inria.fr (Postfix) with ESMTPS id 4F1CF7FE44 for ; Wed, 6 Jul 2016 11:21:58 +0200 (CEST) IronPort-PHdr: 9a23:Ji+WYh0LQdu2PjLdsmDT+DRfVm0co7zxezQtwd8ZsegQLfad9pjvdHbS+e9qxAeQG96Ks7Qe1aGO7ejJYi8p2d65qncMcZhBBVcuqP49uEgeOvODElDxN/XwbiY3T4xoXV5h+GynYwAOQJ6tL2PbrnD61zMOABK3bVMzfbWtXNSMxJzpn8mJuLTrKz1SgzS8Zb4gZD6Xli728vcsvI15N6wqwQHIqHYbM85fxGdvOE7B102kvpT4r9Zf9HEasPsk84tEUL7mV6U+V71RSjo8eShh78TusVzHTBCTznoaSGQf1BRSVVvr9hb/C93KtSb1qvB6wG3SGMz9Tbk5XX7qu6JqQx/hhSNBLDk0/33NjdRYjaRHrRbnrBt6ld2HKLqJPeZzK/uONegRQnBMC55c Authentication-Results: mail2-smtp-roc.national.inria.fr; spf=None smtp.pra=michael.soegtrop@intel.com; spf=Pass smtp.mailfrom=michael.soegtrop@intel.com; spf=None smtp.helo=postmaster@mga09.intel.com Received-SPF: None (mail2-smtp-roc.national.inria.fr: no sender authenticity information available from domain of michael.soegtrop@intel.com) identity=pra; client-ip=134.134.136.24; receiver=mail2-smtp-roc.national.inria.fr; envelope-from="michael.soegtrop@intel.com"; x-sender="michael.soegtrop@intel.com"; x-conformance=sidf_compatible Received-SPF: Pass (mail2-smtp-roc.national.inria.fr: domain of michael.soegtrop@intel.com designates 134.134.136.24 as permitted sender) identity=mailfrom; client-ip=134.134.136.24; receiver=mail2-smtp-roc.national.inria.fr; envelope-from="michael.soegtrop@intel.com"; x-sender="michael.soegtrop@intel.com"; x-conformance=sidf_compatible; x-record-type="v=spf1" Received-SPF: None (mail2-smtp-roc.national.inria.fr: no sender authenticity information available from domain of postmaster@mga09.intel.com) identity=helo; client-ip=134.134.136.24; receiver=mail2-smtp-roc.national.inria.fr; envelope-from="michael.soegtrop@intel.com"; x-sender="postmaster@mga09.intel.com"; x-conformance=sidf_compatible X-IronPort-Anti-Spam-Filtered: true X-IronPort-Anti-Spam-Result: A0BJAABYzXxXhxiIhoZdgnCBJHwGuUKBdxqFfgKBKzgUAQEBAQEBAQERAQEBCA0JCSEkC4IygiEtHEIBKlYmAQQbiCcBnBCfXAwlhiiJDoJHC1iCEh0FmQ0GAYEwnECQCh6CT4FXbodzAX4BAQE X-IPAS-Result: A0BJAABYzXxXhxiIhoZdgnCBJHwGuUKBdxqFfgKBKzgUAQEBAQEBAQERAQEBCA0JCSEkC4IygiEtHEIBKlYmAQQbiCcBnBCfXAwlhiiJDoJHC1iCEh0FmQ0GAYEwnECQCh6CT4FXbodzAX4BAQE X-IronPort-AV: E=Sophos;i="5.28,318,1464645600"; d="scan'208,217";a="225769433" Received: from mga09.intel.com ([134.134.136.24]) by mail2-smtp-roc.national.inria.fr with ESMTP; 06 Jul 2016 11:21:26 +0200 Received: from orsmga003.jf.intel.com ([10.7.209.27]) by orsmga102.jf.intel.com with ESMTP; 06 Jul 2016 02:21:25 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.28,318,1464678000"; d="scan'208,217";a="841374596" Received: from irsmsx101.ger.corp.intel.com ([163.33.3.153]) by orsmga003.jf.intel.com with ESMTP; 06 Jul 2016 02:21:24 -0700 Received: from irsmsx102.ger.corp.intel.com ([169.254.2.10]) by IRSMSX101.ger.corp.intel.com ([169.254.1.155]) with mapi id 14.03.0248.002; Wed, 6 Jul 2016 10:21:22 +0100 From: "Soegtrop, Michael" To: "caml-list@inria.fr" Thread-Topic: Ocamldoc ignores section header special comments Thread-Index: AdHXZ65nK2w5qmoYRvu8ALTeiIlCfA== Date: Wed, 6 Jul 2016 09:21:22 +0000 Message-ID: <0F7D3B1B3C4B894D824F5B822E3E5A172CF1F269@IRSMSX102.ger.corp.intel.com> Accept-Language: de-DE, en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-originating-ip: [163.33.239.181] Content-Type: multipart/alternative; boundary="_000_0F7D3B1B3C4B894D824F5B822E3E5A172CF1F269IRSMSX102gercor_" MIME-Version: 1.0 Subject: [Caml-list] Ocamldoc ignores section header special comments --_000_0F7D3B1B3C4B894D824F5B822E3E5A172CF1F269IRSMSX102gercor_ Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable 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 g= enerates 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 co= ntext. If I have more than one module in a file, do the section headers bel= ong 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 --_000_0F7D3B1B3C4B894D824F5B822E3E5A172CF1F269IRSMSX102gercor_ Content-Type: text/html; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable

Dear OCaml Users,

 

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

 

The syntax I am using is

 

(** {2 Lexer utilities} *)

 

One thing I didn’t fully understand from the d= ocumentation is if ocamldoc generates one HTML file per module or one per M= L 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

--_000_0F7D3B1B3C4B894D824F5B822E3E5A172CF1F269IRSMSX102gercor_--