Extracting comments from C code

Thread View: comp.text.sgml

4 messages

[T] Back to Threads [V] Tree View [G] Group Articles

4 total messages Started by Stephen Saroff Wed, 10 Apr 1996 12:04

#634

Author: Stephen Saroff
Date: Wed, 10 Apr 1996 12:04

7 lines
710 bytes

I am looking for some documentation tool for extracting comments from C 
code to be included into documentation.

I know there are some conventions (like /** for Java I think) but does 
anyone know of any other systems?

Thanks.

Re: Extracting comments from C code

#635

Author: Christophe Blaess
Date: Thu, 11 Apr 1996 00:53

13 lines
1173 bytes

In article <4kg84v$if9@solutions.solon.com>, saroff@pobox.com says...
>
>I am looking for some documentation tool for extracting comments from C 
>code to be included into documentation.
>
 You can easily do a little program for Lex wich can extract the comments
and put them in an other text file. There are some classical examples for
discarding comments - even nested - with Lex.(see 'Lex and Yacc' - O'Reilly) 
Then you just have to reverse the process.

[Of course, C has no nested comments, and I believe I once saw a proof
 that lex and yacc can't generically handle the language of nested
 comments, but that hardly matters. -mod]

Re: Extracting comments from C code

#636

Author: Patrice Bonhomme
Date: Thu, 11 Apr 1996 11:38

29 lines
2036 bytes

There is a package called c2man, a program for generating Unix style manual pages in nroff/troff
-man, TeXinfo, LaTeX or HTML format directly from ordinary comments embedded in
C source code. It should run on virtually any Unix-like system, OS/2, VMS,
MSDOS or Amiga systems.

You can get it freely at:
 http://avalon.phys.hokudai.ac.jp/pub/hpux/Languages/c2man-2.40/

-- 
******************************************************************
  PAT                 _[___]_
                      `(O_O)'
                      (  o  )         
  ==================^^^=====^^^=================================
  patrice.bonhomme@loria.fr       |         Office : B.228
  http://www.loria.fr/~bonhomme   |         Phone  : 83 59 20 37
  --------------------------------------------------------------
     1/ Lingua: Multilingual Concordancing European Project:
                    http://www.loria.fr/~bonhomme/lingua/
     2/ Aquarelle   http://aqua.inria.fr
     3/ Silfide     http://www.loria.fr/Projet/Silfide
  ==============================================================
                      ()   ()              "earth tone suits you
                     / |   | \                so give it a smile
                   ooooO   Ooooo  if i could hold your feet down
                                         get to know for awhile"
  A BIENTOT !!                       "In The MeanTime" by HELMET.
******************************************************************

Re: Extracting comments from C code

#637

Author: Mike Davis
Date: Thu, 11 Apr 1996 18:58

12 lines
992 bytes

Patrice Bonhomme writes:


   There is a package called c2man. . .

I tried this package, and for about 1/2 the files in my existing code
that I tried it on, it produced no output.  Those which it did handle,
it did nicely.  It would be a great tool if you were starting from
scratch and could code to the layout that c2man handles best.

- --mad

Thread Navigation

This is a paginated view of messages in the thread with full content displayed inline.

Messages are displayed in chronological order, with the original post highlighted in green.

Use pagination controls to navigate through all messages in large threads.

Back to All Threads