[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-core-devel
Subject:    Re: Proposal: replace KDOC with Doxygen after 2.0 (fwd)
From:       Stephan Kulow <coolo () kde ! org>
Date:       2000-10-22 23:49:38
[Download RAW message or body]

Richard Moore wrote:
> 
> Antonio Larrosa Jiménez wrote:
> >
> > Peter Putzer escribió:
> > >
> > > >
> > > > - Can we force people to use the java doc syntax? I think
> > > > we should.
> > >
> > > Why? Actually I find the "LaTex" ("\command") syntax easier to read, but
> > > that's just a preference.
> > >
> >
> > Peter, can you do a short description of the difference in the
> > "commands" ? (I've only used @p, @ref, @version, @author and a little
> > more)
> >
> > > > - Can we force people to keep their docs in the header files
> > > > not in the .cpp?
> > >
> > > You can't do that now. If I choose to document something in the .cpp (not
> > > that I would, but just in theory), who's there to stop me?
> > >
> >
> > Does that mean that Doxygen doesn't allow having the docs in the
> > header files ?
> 
> No, it supports docs in the header files. The only issue is if you
> can actively stop it allowing people to put their docs in the cpp
> files instead. According to Peter's other mail, the answer is yes.
> 
I don't see it as disadvantage though. Some header files of ours
got a bit _too_ informative. Some short descriptions  in headers
are ok, but long texts get fast on my nerves :)

Greetings, Stephan

-- 
Frauen und Maenner passen vielleicht nicht zusammen, aber meine 
allerschoensten Schrammen habe ich mir bei diesem Duell geholt.
					       -- Reinhard Mey

[prev in list] [next in list] [prev in thread] [next in thread]