SUMMARY: Tool for generating documentation from C-style comments needed.

From: Henrik.Martin (euamhk@eua.ericsson.se)
Date: Tue Jan 28 1992 - 07:40:25 CST


Hi! I got one answer to my question and it comes from Bryant Eastham in
Utah. I include his reply at the end of the article. He says that he
wanted to work a while with the parser before releasing anything. He
also points out that he hasn't got time for support, so I guess that the
parser comes "as is".

euamhk@eua.ericsson.se (Henrik.Martin) writes:

>Hello! I would be very happy if someone out there could give me a hint
>about where to obtain a public domain program that is capable of
>generating some kind of documentation-stubs from C-style source code
>comments.
>I'll summarize of course.
>Thanks in advance!

>--
>Henrik Martin
>Ellemtel Telecommunication Systems Laboratories
>Office phone: + 46 8 727 36 04 Fax: + 46 8 647 82 76
>Email: Henrik.Martin@eua.ericsson.se

>From bryant@ced.utah.edu Tue Jan 21 18:52:36 1992
Return-Path: <bryant@ced.utah.edu>
Received: from mailgate.ericsson.se by eua.ericsson.se (4.1/SMI-4.0.2)
        id AA03151; Tue, 21 Jan 92 18:52:36 +0100
Received: from unknown.CED.UTAH.EDU (ced.utah.edu) by mailgate.ericsson.se (4.1/SMI-4.1-MAILGATE1.10)
        id AA19987; Tue, 21 Jan 92 18:52:29 +0100
Received: from ced.utah.edu (sol.ced.utah.edu) by unknown.CED.UTAH.EDU; Tue, 21
 Jan 92 10:52 MST
Received: from mars.ced.utah.edu.ced.utah.edu by ced.utah.edu (4.1/SMI-4.1) id
 AA14464; Tue, 21 Jan 92 10:52:01 MST
Date: Tue, 21 Jan 92 10:52:01 MST
From: bryant@ced.utah.edu
Subject: Documentation from the code.
To: euamhk@eua.ericsson.se
Message-Id: <9201211752.AA14464@ced.utah.edu>
X-Envelope-To: euamhk@eua.ericsson.se
Status: OR

  Someone in my organization forwarded your request for information to me
because I seem to be working on the same type of thing. For a year or two
our group has been using the same headers for source files, header files
and function blocks. If your interested in seeing them I can forward them,
but the idea is that if everyone is using the same headers it becomes
trivial to write a parser to generate documentation from the source. The
idea is that a function header looks something like this:

  /*function~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   *
   * Name :
   * Date :
   * anything_else_you_want.
   *~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/

The parser can then look for comments that begin with the word "function"
and then can parse the function.

  If your interested in more information, I'll gladly share my efforts.

  Bryant Eastham
  bryant@ced.utah.edu

  University of Utah

--
Henrik Martin 
Ellemtel Telecommunication Systems Laboratories
Office phone: + 46 8 727 36 04 Fax: + 46 8 647 82 76
Email: Henrik.Martin@eua.ericsson.se



This archive was generated by hypermail 2.1.2 : Fri Sep 28 2001 - 23:06:35 CDT