[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: continuing documentation
From: |
Bill White |
Subject: |
Re: continuing documentation |
Date: |
Thu, 21 Jun 2001 10:38:51 -0400 |
User-agent: |
Mutt/1.2.5i |
Have you looked at doxygen? It lets you put things in the code
or out of it. I'm using it for my current project at my work,
in a design of a symbol table, and I think it's very useful.
On Thu, Jun 21, 2001 at 10:11:10AM -0400, Maurizio Boriani wrote:
> -- On 18 Jun 2001 10:34:48 -0600 Gordon Matzigkeit wrote --
>
> > I looked at automatic tools for doing this kind of thing, but they all
> > failed to provide ways of working around text in the generated output.
> > I wouldn't want to put all the text into the header files.
> >
> > My latest direction has been to have a little tool that would scan the
> > headers for functions that aren't documented in the manual. It would
> > also provide convenient ways of moving the manual description to the
> > header files, and vice versa.
>
> Hi,
> I think this is a good idea, but I could be usefull a tool which can
> parse some code comment and put out docs about code and relations btw
> different source file. The output could be html or sgml (which can be
> translater in different format easly). A similar thing I saw in jdk java
> documentor which put out html cource about code (mainly classes). Could this
> be a good idea? What do you think?
>
> bye
>
>
> _______________________________________________
> Bug-hurd mailing list
> Bug-hurd@gnu.org
> http://mail.gnu.org/mailman/listinfo/bug-hurd
--
Lex clavatoris designati rescindenda est.
bill.white@griggsinst.org Griggs Research Institute
- Re: continuing documentation, Maurizio Boriani, 2001/06/21
- Re: continuing documentation,
Bill White <=
- Re: continuing documentation, Gordon Matzigkeit, 2001/06/21
- Re: continuing documentation, OKUJI Yoshinori, 2001/06/21
- Re: continuing documentation, Gordon Matzigkeit, 2001/06/21
- Re: continuing documentation, Roland McGrath, 2001/06/21
- Re: continuing documentation, OKUJI Yoshinori, 2001/06/21
- Re: continuing documentation, Gordon Matzigkeit, 2001/06/22
- Re: continuing documentation, OKUJI Yoshinori, 2001/06/23
- Re: continuing documentation, Gordon Matzigkeit, 2001/06/23
- Re: continuing documentation, Maurizio Boriani, 2001/06/26
- Re: continuing documentation, Gordon Matzigkeit, 2001/06/28