From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail1-relais-roc.national.inria.fr (mail1-relais-roc.national.inria.fr [192.134.164.82]) by walapai.inria.fr (8.13.6/8.13.6) with ESMTP id q1FAq8IV006512 for ; Wed, 15 Feb 2012 11:52:08 +0100 X-IronPort-Anti-Spam-Filtered: true X-IronPort-Anti-Spam-Result: Ag4CAGaNO0/RVdS0kGdsb2JhbABDn0mQeggiAQEBAQkJDQcUBCOBcgEBAQQBAQEPAiwBGxILAQMIBAYFCwYBAgECAQ0hIQEBBAEMAQUBCgQGCAYBEgkJCQeHZpwkCotxgnGFAD+IcwIFC4g5gykFDwsTDhIDCAEGAwIDBIQIBAUCEAEIAoMvBJMOgiiLE4MWPYQD X-IronPort-AV: E=Sophos;i="4.73,422,1325458800"; d="scan'208";a="144338865" Received: from mail-wi0-f180.google.com ([209.85.212.180]) by mail1-smtp-roc.national.inria.fr with ESMTP/TLS/RC4-SHA; 15 Feb 2012 11:52:02 +0100 Received: by wibhm6 with SMTP id hm6so688673wib.39 for ; Wed, 15 Feb 2012 02:52:02 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=gamma; h=mime-version:in-reply-to:references:from:date:message-id:subject:to :cc:content-type:content-transfer-encoding; bh=jxJQ/VnJooGpBKQpMNtY38Py5xInCghnfcalIeQB96M=; b=rsD2NfLhQMFfVwQk+H9kLJPmiaTBkgNYszmoszXknXo1bMNsacFLW7nefx9z0bIJKQ 3WfrqT8P+zH0rzj/3d+AcUR9DhK9/avZ2reqLb4kPSAB4vxIUDScoJEegCwpYzn3UNCa cR/37SHPLZcSFZF9o+tC71l50YjkrO8YqlTQE= Received: by 10.180.85.105 with SMTP id g9mr7634905wiz.12.1329303122227; Wed, 15 Feb 2012 02:52:02 -0800 (PST) MIME-Version: 1.0 Received: by 10.227.61.7 with HTTP; Wed, 15 Feb 2012 02:51:22 -0800 (PST) In-Reply-To: <20120215094440.01705df2@alcazar> References: <4F3B65B9.5010704@riken.jp> <20120215094440.01705df2@alcazar> From: Gabriel Scherer Date: Wed, 15 Feb 2012 11:51:22 +0100 Message-ID: To: Maxence Guesdon , Vincent HUGOT Cc: Francois Berenger , caml-list@yquem.inria.fr Content-Type: text/plain; charset=ISO-8859-1 Content-Transfer-Encoding: 8bit X-MIME-Autoconverted: from quoted-printable to 8bit by walapai.inria.fr id q1FAq8IV006512 Subject: Re: [Caml-list] Fwd: Re: [Batteries-devel] browsing the code while reading the doc My mistake, I wasn't aware or had forgotten this -- very useful indeed -- feature. Thanks, Vincent and Maxence, for the correction. (Gabriel; sometimes "bluestorm", for historical reasons, and often "gasche".) On Wed, Feb 15, 2012 at 9:44 AM, Maxence Guesdon wrote: > Hello, > > If you provide the .ml files to ocamldoc and use the -keep-code option, > generated html pages will give a link on each value to display the > corresponding code. > > Another solution would be to adapt the odoc_literate custom generator you > can find here: >  https://gitorious.org/ocamldoc-generators > This generator provide an expand/collpase button for each value, useful when > writing doc in a literate programming way. > > At last, since Dynlink now allows loading native code, ocamldoc now > supports loading custom generators compiled to native code, which may be > fast enough to use the batteries legacy generator. > > Hope this helps, > > Maxence > > On Wed, 15 Feb 2012 16:58:49 +0900 > Francois Berenger wrote: > >> -------- Original Message -------- >> Subject: Re: [Batteries-devel] browsing the code while reading the doc >> Date: Wed, 15 Feb 2012 08:47:42 +0100 >> From: bluestorm >> To: Francois Berenger >> CC: batteries-devel@lists.forge.ocamlcore.org >> >> We delegate documentation production to the standard ocamldoc tool, >> which doesn't have this feature, so that is not really in the game >> zone of batteries developers. That said, it *could* be possible to >> make that feature available without changing ocamldoc upstream, by >> implementing it as a custom documentation formatter -- ocamldoc has a >> flexible architecture in this regard. >>    http://caml.inria.fr/pub/docs/manual-ocaml/manual029.html#toc120 >> >> Xavier Clerc has some experience tuning ocamldoc ( >> http://argot.x9c.fr/ ), maybe he could comment on the feasibility of >> this. You could ask on the caml-list, maybe cc-ing him. If you wished >> to have a try at it directly, looking at how Argot is implemented >> would be a good source of inspiration. >> >> (There used to be a custom documentation generator for Batteries, but >> afaik. we mostly ditched it because, while it was nice, it made >> documentation generation time impossibly slow...) >> >> On Wed, Feb 15, 2012 at 6:01 AM, Francois Berenger >> wrote: >> > Hello, >> > >> > It would be really cool when while looking at the HTML doc >> > it would be possible to click somewhere so that the implementation >> > code unrolls under the doc text. >> > >> > Because sometimes the text is not explicit enough, >> > some other times there is no text. >> > >> > Hoogle has such feature and it was pretty useful when >> > I was coding in Haskell (maybe especially useful >> > because I was a beginner in that language), for example: >> > >> > http://www.haskell.org/hoogle/?hoogle=map >> > >> > Just click on map to have a look at the corresponding implementation. >> > >> > Regards, >> > F. >> > >> > >> > _______________________________________________ >> > Batteries-devel mailing list >> > Batteries-devel@lists.forge.ocamlcore.org >> > https://lists.forge.ocamlcore.org/cgi-bin/listinfo/batteries-devel >> >> -- >> Caml-list mailing list.  Subscription management and archives: >> https://sympa-roc.inria.fr/wws/info/caml-list >> Beginner's list: http://groups.yahoo.com/group/ocaml_beginners >> Bug reports: http://caml.inria.fr/bin/caml-bugs >> > > > -- > Caml-list mailing list.  Subscription management and archives: > https://sympa-roc.inria.fr/wws/info/caml-list > Beginner's list: http://groups.yahoo.com/group/ocaml_beginners > Bug reports: http://caml.inria.fr/bin/caml-bugs >