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

List:       kde-devel
Subject:    Re: KFile plugins
From:       Kevin Krammer <kevin.krammer () gmx ! at>
Date:       2005-10-14 19:23:02
Message-ID: 200510142123.03083.kevin.krammer () gmx ! at
[Download RAW message or body]

[Attachment #2 (multipart/signed)]


On Friday 14 October 2005 20:33, Thomas Kadauke wrote:
> Am Thursday 13 October 2005 21:52 schrieb Adriaan de Groot:
> > To some extent, these tutorials should be _in_ the APIDOX, as extra pages
> > or as overview documentation for the classes (or a collection of classes)
> > so that (a) they're available everywhere (b) easier to find (by just
> > looking at the documentation) (c) they get checked for validity and
> > accuracy regularly. So your offer to extend the dox is still in force?
>
> I changed the documentation of KFilePlugin (see attached file). Please tell
> me if it is good or not. If yes, I will work on the other documentation and
> post a diff. Note that I didn't change the public part of the class'
> documentation.

Good work!

Just some stylistic hints:

When usign methods names in the text, add parenthese to their names, so 
Doxygen knows it is a method.
For example instead of

"You must overwrite the readInfo method."

you could write

"You must overwrite the readInfo() method."

or

"You must overwrite readInfo()"

When mentioning special value like in

"@return true if successful, false if it failed"

add @c markup for them like this

"@return @c true if successful, @c false if it failed"

For consistency with the other markup I suggest using @code and @encode 
instead of \code and \endcode

The error list of kfilemetainfo.h is now down to three (actually two, the last 
one is a consequence of the second one)

/dvl/kdesvn/kdelibs/kio/kio/kfilemetainfo.h:1501 Warning: The following 
parameters of KFilePlugin::appendItem(KFileMetaInfoGroup &group, const 
QString &key, QVariant value) are not documented:
  parameter value

/dvl/kdesvn/kdelibs/kio/kio/kfilemetainfo.h:1479 Warning: argument `prefix' of 
command @param is not found in the argument list of 
KFilePlugin::setSuffix(KFileMimeTypeInfo::ItemInfo *item, const QString 
&suffix)

/dvl/kdesvn/kdelibs/kio/kio/kfilemetainfo.h:1479 Warning: The following 
parameters of KFilePlugin::setSuffix(KFileMimeTypeInfo::ItemInfo *item, const 
QString &suffix) are not documented:
  parameter suffix

Cheers,
Kevin

-- 
Kevin Krammer <kevin.krammer@gmx.at>
Qt/KDE Developer, Debian User
Moderator: www.mrunix.de (German), www.qtforum.org

[Attachment #5 (application/pgp-signature)]

 =

>> Visit http://mail.kde.org/mailman/listinfo/kde-devel#unsub to unsubscrib=
e <<


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