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

List:       kde-core-devel
Subject:    Documentation standard ??
From:       Michael Koch <m_koch () bigfoot ! de>
Date:       1999-07-07 12:34:28
[Download RAW message or body]

Am Mit, 07 Jul 1999 schrieb Mirko Sucker:
> Hello,
> like we discussed on LinuxTag in Kaiserslautern, I added two classes to the KDE
> user interface library: 
> 
> ° DialogBase (dialogbase.h, dialogbase.cpp):
> 
> A class that manages common tasks required for writing up-to-date dialogs. It
> provides "OK", "Apply" and "Cancel" buttons, tooltips, quickhelp, a link to
> show the help window, some frames and general geometry management. To use it,
> simply create a widget that suits as the main part of the dialog, set its
> minimum size and hand it over to a DialogBase object as the dialogs "main
> widget". Mostly it is not needed to derive a own dialog class.
> 
> ° KAboutDialog (kaboutdialog.h, kaboutdialog.cpp):
> 
> A general about dialog for KDE apps, providing logos, displays for author,
> maintainer, an arbitrary number of contributors and  email and homepage URLs.
> Again, to use it, only a sequence of calls is needed, no new class. 
> 
> ---------
> I have an example for both (KAboutDialog is a DialogBase) called
> kaboutdialog_test.cc, is there a place to put it?

Mirko, 

I have seen, that you documented your classes with another tool that kdoc. Your
docifier is not compatible with kdoc (or inverted).
But I saw your API-Doc on Linuxday, and it was great. It was like QT-API-Docu.

WE SHOULD HAVE ONLY ONE DOCUMENTATION STANDARD!!!!!!!

Should we change the doc-tool or remain with kdoc and change the documentation
in this two classes to kdoc-standard ?

Any comments ???



--
Michael Koch

KDE fan, enthusiast and developer
projects: Katabase and KImageShop
writing documentation of KOM/OP

student of computer science at
university of applied sciences
Darmstadt, Germany

koch@kde.org and mkoch@mail.riednet.wh.tu-darmstadt.de
http://www.riednet.wh.tu-darmstadt.de/~mkoch

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