From: Francois Berenger <berenger@riken.jp>
To: caml-list@yquem.inria.fr
Subject: [Caml-list] Fwd: Re: [Batteries-devel] browsing the code while reading the doc
Date: Wed, 15 Feb 2012 16:58:49 +0900 [thread overview]
Message-ID: <4F3B65B9.5010704@riken.jp> (raw)
-------- Original Message --------
Subject: Re: [Batteries-devel] browsing the code while reading the doc
Date: Wed, 15 Feb 2012 08:47:42 +0100
From: bluestorm <bluestorm.dylc@gmail.com>
To: Francois Berenger <berenger@riken.jp>
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 <berenger@riken.jp>
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
next reply other threads:[~2012-02-15 7:58 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-02-15 7:58 Francois Berenger [this message]
2012-02-15 8:44 ` Maxence Guesdon
2012-02-15 10:51 ` Gabriel Scherer
2012-02-15 9:55 ` Gerd Stolpmann
2012-02-15 11:20 ` Daniel Bünzli
2012-02-16 2:11 ` Francois Berenger
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=4F3B65B9.5010704@riken.jp \
--to=berenger@riken.jp \
--cc=caml-list@yquem.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).