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 q1F7wweK032160 for ; Wed, 15 Feb 2012 08:58:59 +0100 X-IronPort-Anti-Spam-Filtered: true X-IronPort-Anti-Spam-Result: AgwCAHJlO0+GoCGimWdsb2JhbABDgw2tegEBAQEBCAsLBxQngXIBAQEFAQE1NgoNIAECAQIBCRYYAwIBAgEPBgEhBAIbBgIBAQWHfJk9oAOIRIMlCRoTDwECDgMIAQYDAgMHDgmDRQEIDgEIAwYJAhAJAhKDHQSISYpDgiiFXIU2h2M X-IronPort-AV: E=Sophos;i="4.73,422,1325458800"; d="scan'208";a="144306035" Received: from postman2.riken.jp (HELO postman.riken.jp) ([134.160.33.162]) by mail1-smtp-roc.national.inria.fr with ESMTP; 15 Feb 2012 08:58:52 +0100 Received: from postman.riken.jp (postman2.riken.jp [127.0.0.1]) by postman.riken.jp (Postfix) with SMTP id 7B3ED12602EF for ; Wed, 15 Feb 2012 16:58:49 +0900 (JST) Received: from [172.27.98.103] (rikad98.riken.jp [134.160.214.98]) by postman.riken.jp (Postfix) with ESMTPA id 57B631270063 for ; Wed, 15 Feb 2012 16:58:49 +0900 (JST) Message-ID: <4F3B65B9.5010704@riken.jp> Date: Wed, 15 Feb 2012 16:58:49 +0900 From: Francois Berenger User-Agent: Mozilla/5.0 (X11; U; Linux x86_64; en-US; rv:1.9.2.26) Gecko/20120131 Thunderbird/3.1.18 MIME-Version: 1.0 To: caml-list@yquem.inria.fr Content-Type: text/plain; charset=ISO-8859-1; format=flowed Content-Transfer-Encoding: 7bit X-PMX-Version: 5.6.0.2009776, Antispam-Engine: 2.7.2.376379, Antispam-Data: 2012.2.15.74216 Subject: [Caml-list] Fwd: Re: [Batteries-devel] browsing the code while reading the doc -------- 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