[Wikitech-l] broken documentation links

[Rob Church]

On 19/04/06, Ævar Arnfjörð Bjarmason <avarab at gmail.com> wrote:
> On 4/18/06, Tels <nospam-abuse at bloodgate.com> wrote:
> > Moin,
> > Actually, I wanted to find documentation on the Parser class, it's
> > functions and members. However, the automatic documentation feature
> > doesn't seem to offer much more then "this function does exist and has
> > the following params".
> >
> > I expected a lot more text like: what does it do? What are the params
> > actually? what some possible values? etc.
> >
> > So, I am not sure if the autogenerated doc is very usefull at all. It's a
> > start, but in the end I just looked in the source whenever I wanted to
> > see how something really works :)
>
> Automatically generated documentation will only ever be as good as the
> source code (or other data) it's generated from. So this is a symptom
> of classes and other interfaces not being documented well enough, not
> of the documentation system as such.

Got it in one. If the comments are wrong, then the documentation will be, too.


Rob Church