Path: utzoo!utgpu!watserv1!watmath!watmsg!gjditchfield
From: gjditchfield@watmsg.waterloo.edu (Glen Ditchfield)
Newsgroups: comp.lang.c++
Subject: Re: Class documentation -- invitation for discussion.
Message-ID: <35392@watmath.waterloo.edu>
Date: 19 Mar 90 20:20:39 GMT
References: <BESHERS.90Mar18161436@division.cs.columbia.edu>
Sender: daemon@watmath.waterloo.edu
Reply-To: gjditchfield@watmsg.waterloo.edu (Glen Ditchfield)
Distribution: comp
Organization: U. of Waterloo, Ontario
Lines: 8

I would like class documentation to start with a "synopsis" section, which
would be just the class declaration with "private" sections and inline
function bodies stripped out (and possibly "inline" keywords and private
inheritance clauses stripped, since these are arguably implementation
details).  I used to have an ugly lex script that created such things from
.h files...
   When I look at documentation, I usually just want to remind myself what
the name of a function was, or what order the parameters go in.