Version française
Home     About     Download     Resources     Contact us    
Browse thread
[Caml-list] CDK binary release
[ Home ] [ Index: by date | by threads ]
[ Search: ]

[ Message by date: previous | next ] [ Message in thread: previous | next ] [ Thread: previous | next ]
Date: -- (:)
From: John Max Skaller <skaller@o...>
Subject: Re: [Caml-list] CDK binary release
Markus Mottl wrote:

> I have just taken a look at the way documentation is handled. It would
> be fine if there were some kind of standard way to prepare documentation
> for OCaml-sources in general. It's otherwise a tremendous effort to
> maintain various formats (and who likes writing documentation anyway? ;)

	But the CDK generates documentation is a way that clearly
defines such a 'standard'. So what's needed is a description
of this for people preparing packages for inclusion in CDK.

	I'd also suggest that every package be allowed a 
'native html documentation directory'. If present,
a link in the generated documentation to it would allow the
reader to go the suppliers original html documentation.

	[For example, if there is a 'doc' directory
in the package, the CDK summary could include a link
to 'doc/index.html']

-- 
John (Max) Skaller, mailto:skaller@maxtal.com.au
10/1 Toxteth Rd Glebe NSW 2037 Australia voice: 61-2-9660-0850
checkout Vyper http://Vyper.sourceforge.net
download Interscript http://Interscript.sourceforge.net
-------------------
To unsubscribe, mail caml-list-request@inria.fr.  Archives: http://caml.inria.fr