From kde-pim  Tue Jul 26 17:19:24 2011
From: "Kevin Krammer" <kevin.krammer () gmx ! at>
Date: Tue, 26 Jul 2011 17:19:24 +0000
To: kde-pim
Subject: [Kde-pim] Re: Review Request: New NoteUtils namespace with
Message-Id: <20110726171924.2106.91814 () vidsolbach ! de>
X-MARC-Message: https://marc.info/?l=kde-pim&m=131170080130167


-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
http://git.reviewboard.kde.org/r/102076/#review5121
-----------------------------------------------------------

Ship it!


Just a couple of tips regarding API docs:
- use named parameters, especially when a method takes more than one
- refer to parameters inside documentation text using @p markup, e.g. @p text
- depending on whether parameters need to be documented more clearly than just referring to them in the method's description, add @param lines
- remember that API docs can generate alphabetically sorted lists of methods, so getters and setters might end up apart from each other
- you can link to other methods by just writing their name followed by empty parentheses, e.g. "A plain text version of the @p text can be retrieved by calling toPlainText()"
- it can help to explain the usage of a class by adding a small block of example code to the class' documentation by using @code and @endcode around it

- Kevin


On July 26, 2011, 4:18 p.m., Christian Mollekopf wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> http://git.reviewboard.kde.org/r/102076/
> -----------------------------------------------------------
> 
> (Updated July 26, 2011, 4:18 p.m.)
> 
> 
> Review request for Akonadi, KDEPIM-Libraries and Stephen Kelly.
> 
> 
> Summary
> -------
> 
> NoteMessageWrapper is a convenience class to assemble/disassemble Kmime messages into notes(text message).
> This is a first step to standardize how notes are handled with akonadi/akonotes resource.
> 
> The class will be used by the upcoming akonotes-nepomuk-feeder as well as MindMirror.
> (Of course also kjots and any other app working with the akonotes resource might make use of it)
> 
> I put the files in a new notes directory, so we can put there future efforts like an even more convenient Note class,
> which I briefly discussed with skelly.
> 
> The NoteUtils namespace can be used for further note related helper functions/classes.
> 
> As skelly already had a look at it I will commit if noone objects within the next days.
> 
> 
> Diffs
> -----
> 
>   akonadi/notes/noteutils.cpp PRE-CREATION 
>   KdepimLibsConfig.cmake.in 3615dd71cf7eeba90d99ac0006c64075cdf38e38 
>   akonadi/CMakeLists.txt cf63a0db5d7139d29cad268cd7aeaaa9a00e3cf1 
>   akonadi/notes/CMakeLists.txt PRE-CREATION 
>   akonadi/notes/akonadi-notes_export.h PRE-CREATION 
>   akonadi/notes/noteutils.h PRE-CREATION 
> 
> Diff: http://git.reviewboard.kde.org/r/102076/diff
> 
> 
> Testing
> -------
> 
> 
> Thanks,
> 
> Christian
> 
>

_______________________________________________
KDE PIM mailing list kde-pim@kde.org
https://mail.kde.org/mailman/listinfo/kde-pim
KDE PIM home page at http://pim.kde.org/