mathlib-develop

[Mathlib-develop] Documentation updates

[mark <msp...@ya...>]

Hi

I'm about to start on an update of the MathLib Documentation and wanted t=
o go=20
over a couple of ideas.

Firstly I'm thinking about splitting the docs into three parts
User Manual
Implementation Manual
Function Reference

Secondly I think that the implementation manual should be included in the=
 code=20
using Javadoc. I've found a doclet which allows the JavaDoc tool to outpu=
t=20
docbook xml. I think doing it this way will help keep the docs up to date=
=20
with the code.

Does anyone have any comments?

Best Regards

Mark Sparshatt

Re: [Mathlib-develop] Documentation updates

[Stefan M. <st...@he...>]

mark wrote:

> Hi
> 
> I'm about to start on an update of the MathLib Documentation and wanted to go 
> over a couple of ideas.
> 
> Firstly I'm thinking about splitting the docs into three parts
> User Manual
> Implementation Manual
> Function Reference
> 
> Secondly I think that the implementation manual should be included in the code 
> using Javadoc. I've found a doclet which allows the JavaDoc tool to output 
> docbook xml. I think doing it this way will help keep the docs up to date 
> with the code.
> 
> Does anyone have any comments?
I aggree.

Kind regards,
   Stefan

------------------------------------
Dr.-Ing. Stefan Mueller
email: St...@he...
------------------------------------