Path: utzoo!utgpu!jarvis.csri.toronto.edu!mailrus!cs.utexas.edu!uunet!ncrlnk!ncr-sd!hp-sdd!hp-pcd!hplsla!jima
From: jima@hplsla.HP.COM (Jim Adcock)
Newsgroups: comp.lang.c++
Subject: Re: Class documentation
Message-ID: <6590283@hplsla.HP.COM>
Date: 6 Oct 89 17:53:10 GMT
References: <662@hsi86.hsi.UUCP>
Organization: HP Lake Stevens, WA
Lines: 10

I don't know about "automatically" generating the documentation, but most
helpful for me is to have on-line unix-style manual pages.  If one is
serious about writing reusable classes, one ought to at least have the
motivation to write a manual page on them.  One shouldn't have to read code
to figure out how to use someone else's classes.

And PLEASE name your manual page after your class name.  I can't tell you
how tired I get of failing on "man complex" and then having to search my
file system to find what gd manual page name the info on the complex classes
is stored under.