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

List:       kde-kdoc
Subject:    Re: '@sect' tags
From:       Wolfgang Bangerth <Wolfgang.Bangerth () IWR ! Uni-Heidelberg ! De>
Date:       2000-08-07 7:21:55
[Download RAW message or body]


> The fact that the header appears after the method it
> precedes in the .h file is the real issue. Of course what I can do is
> append the header to the doc comment of the previous method, but that
> means that the .h file will "know" the layout order of kdoc. Moreover,
> it will greatly reduce the man-readability of the .h file. 

I know what you want to do, but that is not the intention of the present
output, I guess. The overall structure (i.e. layout and top level section
headers) is imposed by kdoc, which, by the way, also reshuffles methods,
variables, and typedefs. So giving section headers to particular sections
of a .h files is something that will not work.

What you would need here is a feature that doc++ has: tags like //@{ 
(or so, don't remember their exact syntax anymore, that group together
sections of a class declaration. That would mean that kdoc would only be
allowed to reshuffle things within each of these sections, and I guess
that would fit your needs then. However, such a thing is not implemented
at present, but you're free to do so.

Regards
  Wolfgang

-------------------------------------------------------------------------
Wolfgang Bangerth          email: wolfgang.bangerth@iwr.uni-heidelberg.de
                             www: http://gaia.iwr.uni-heidelberg.de/~wolf

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