--===============0442805238==
Content-Type: multipart/signed;
  boundary="nextPart1840224.B329vaE7ho";
  protocol="application/pgp-signature";
  micalg=pgp-sha1
Content-Transfer-Encoding: 7bit

--nextPart1840224.B329vaE7ho
Content-Type: text/plain;
  charset="iso-8859-15"
Content-Transfer-Encoding: quoted-printable
Content-Disposition: inline

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 pag=
es
> > or as overview documentation for the classes (or a collection of classe=
s)
> > 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 te=
ll
> me if it is good or not. If yes, I will work on the other documentation a=
nd
> 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=20
Doxygen knows it is a method.
=46or 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"

=46or consistency with the other markup I suggest using @code and @encode=20
instead of \code and \endcode

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

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

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

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

Cheers,
Kevin

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

--nextPart1840224.B329vaE7ho
Content-Type: application/pgp-signature

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.2 (GNU/Linux)

iD8DBQBDUAWXnKMhG6pzZJIRApAWAJ0aZM8GxqK65H1y1nufzCRaKWAjdACfR9vT
tcm+aUt0PHuQNdCxOMwETbc=
=WVJo
-----END PGP SIGNATURE-----

--nextPart1840224.B329vaE7ho--

--===============0442805238==
Content-Type: text/plain; charset="iso-8859-1"
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable
Content-Disposition: inline

 =

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

--===============0442805238==--