Re: HTML document generation.

Rene Brun (Rene.Brun@cern.ch)
Fri, 12 Mar 1999 07:38:29 +0000

Piotr Golonka wrote:
>
> Hi!
> I'm just using THTML class to generate a documentation of my diploma
> work and found one thing working not so fine.
>
> Assume You have a constructors, in which You use initializers list as
> in an example:
>
> TMyObject::TMyObject(int x1, int x2):
> fX1(x1),
> fX2(x2)
> {
> ...
> }
>
> If You'll generate the HTML document you'll have this initialization
> list included. It is not a problem if you initializes few variables
> using the lits, but it looks akward if you initialize lets say 15
> variables(!) - generated HTML documentation of constuctor looks really
> cryptic and may scare out every programmer.
>

Hi Piotr,
We had several explicit requests to include the initialisation list
in the html file. Otherwise, you never see the code.
If you find this initialisation method with a long list of arguments
to be cryptic, move the initialisation to the implementation file.
This will also help anyhow people who want to inspect your header file
and do not care about the implementation.

Rene Brun

> My suggestion would be to change THTML behaviour not to include
> initialization list. If you've got other reasons explaining why
> not to use big initialization lists - please, send me Your comments.
>
> cheers!
> Piotr Golonka
>
> PS: send Your comments directly to Piotr.Golonka@cern.ch - I didn't
> subscribe roottalk.