Re: [Debian]: Dokumentation von C++-Sourcen

[Marcus Brinkmann <Marcus.Brinkmann@ruhr-uni-bochum.de>]

On Fri, Aug 14, 1998 at 06:19:36PM +0200, Rainer Dorsch wrote:
> > Hallo!
> > 
> > Vielen Dank für die Hilfe! Über DOC++ bin ich auf kdoc gestoßen, das für
> > meine Zwecke womöglich ausreicht und schön einfach zu handhaben ist.
> > 
> 
> Auch das habe ich probiert. Der Autor meldet sich zwar noch, kommt aber 
> praktisch nicht dazu Bugs zu beseitigen. Es hat einen besseren Eindruck als 
> doc++ 3.0 hinterlassen, aber templates und konstante Funktionen machen ihm zu 
> schaffen.

hast Du mal perceps probiert? Wir benutzen das für die Doklumentation von
Gtk-- (den C++ wrapper von Gtk).

Perceps ist sehr flexibel, es liest alle Klassen, types, members und so
weiter ein, und dann kannst Du templates schreiben, welche die Ausgabe
erzeugen. Wir waren so in der Lage, html, man pages und docbook sgml (!) zu
erzeugen. Mit perl filtern kannst Du jeden Grad an Flexibilität erreichen,
den Du willst.

Ich hab die URL nicht mehr, aber Yahoo findet perceps auf der ersten Seite,
etwa in der Mitte.

#                                  PERCEPS v 3.4.1
#                 A C++ Documentation generator Written in Perl
#                         Copyright (C) 1997 Mark Peskin
#                            mpeskin@mail.utexas.edu

Beispiel für SGML (nur der Kern, es werden noch filter und so benötigt.
Wenn's dich interessiert, mail mir). Die geschweiften Klammern sind perceps
stubs. Zum Beispiel iteriert {foreach class sort} über eine sortierte Liste
aller {classname}:

<Reference>
  <DocInfo><Author><Firstname/Tero/<Surname/Pulkinnen/</Author>
           <Date>{modtime}</Date></DocInfo>
  <Title>&gtkmm; Class Reference</Title>

{foreach class sort}
        {if !name /Proxy/}
                {if !name /signals/}
  <RefEntry ID="{filter sgmlattr}ref.{classname}{endfilter}">
    <IndexTerm><Primary>{classname}</Primary></IndexTerm>

<RefMeta><RefEntryTitle><ClassName>{classname}</ClassName></RefEntryTitle></RefMeta>
    <RefNameDiv><RefName><ClassName>{classname}</ClassName></RefName>
      <RefPurpose>{if brief}{brief}{endif}{else}Sorry, no brief description available yet.{endelse}(#include &lt;{hfile}&gt;)</RefPurpose>
    </RefNameDiv>
    {include refdepends.inc}
    {filter detailpublic}_false_{endfilter}
    {filter detailprotected}_false_{endfilter}
    {filter detailprivate}_false_{endfilter}
    {include memberlist.inc}
                        {if detail}
    <RefSect1><title/Class Description/
        <Para>{detail}</Para>
    </RefSect1>
                        {endif}
    {include memberdesc.inc}
  </RefEntry>
                {endif}
        {endif}
{next}

</Reference>

-- 
"Rhubarb is no Egyptian god."        Debian GNU/Linux        finger brinkmd@ 
Marcus Brinkmann                   http://www.debian.org    master.debian.org
Marcus.Brinkmann@ruhr-uni-bochum.de                        for public  PGP Key
http://homepage.ruhr-uni-bochum.de/Marcus.Brinkmann/       PGP Key ID 36E7CD09
------------------------------------------------
Um sich aus der Liste auszutragen schicken Sie
bitte eine E-Mail an majordomo@jfl.de die im Body
"unsubscribe debian-user-de <your_email_address>"
enthaelt.
Bei Problemen bitte eine Mail an: Jan.Otto@jfl.de
------------------------------------------------
Anzahl der eingetragenen Mitglieder:     544