RE: [Doxygen-users] Making an Easy and fast readable C Library Manual reference.(TODO-Suggestions)

[Stephen G. <ste...@el...>]

Ah, well, there we must part in our ways: I'm afraid that I firmly
believe in restructuring my library architecture (both logical and
physical) if that can help make things clearer. Over the 10-plus years
that my own pet library has been in existence it has been restructured
from top to toe at least three times :-) Nowadays, I do try to restrict
the impact that such structuring has on the public interface, but I feel
at liberty to modify the internals, or new material, at the drop of a
hat.

The single small item I happened to mention (using two levels of
directory to separate public and private interface) was done years
before I even started to use Doxygen: it just happens that that
separation does make it easier to produce good docs - but pretty much
the same result could be reached with more work on the configuration
files (if one has the energy to do that).

Having said that, I _am_ actively fiddling with another part of my
physical design (relating to where/how to arrange examples) simply so
that I _can_ get perfect documentation (hopefully whilst still keeping
to my other goals regarding that code): if I ever manage that then it'll
be put up for public ridicule^h^h^h^h^h^h^h^h acclaim :-) If the
documentation were better, more people would use this library (they
might even _want_ to use it) and I'd feel a fool if I prevented that
because I'd been precious about my wonderful design :-)

Regards,
Stephen Goudge

> -----Original Message-----
> From: dox...@li...=20
> [mailto:dox...@li...] On Behalf=20
> Of Toni Moreno Gim=E9nez
> Sent: 20 November 2001 18:24
> To: Stephen Goudge; dox...@li...
> Subject: Re: [Doxygen-users] Making an Easy and fast readable=20
> C Library Manual reference.(TODO-Suggestions)
<snip>
>=20
> ( and I think is a bad goal , to change architecture design=20
> features only for=20
> doxygen doc generation , Doxygen like a source code=20
> documentation tool may=20
> addapt to any design , I was been studing and working on my=20
> lib design for 2=20
> years and I will not change it , expecting for a perfect=20
> documentation)
>=20
>=20
>=20
> --=20
> =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
> Toni Moreno Gim=E9nez
> =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
> Pje de las rosas  n=BA 22
> Vilassar de Mar=20
> (Barcelona) Espa=F1a
> CP: 08340