[haiku-commits] Re: r40796 - in haiku/trunk/src: apps/codycam apps/deskbar kits/tracker

  • From: "Axel Dörfler" <axeld@xxxxxxxxxxxxxxxx>
  • To: haiku-commits@xxxxxxxxxxxxx
  • Date: Thu, 03 Mar 2011 23:26:59 +0100

jonas@xxxxxxxxxxx wrote:
> +status_t
> +GetLocalizedFileName(entry_ref& ref, BString& localizedFileName, 
> bool traverse)
> +{
> +     // Looks up a localized filename, by reading a catalog signature,
> +     // context and string to be translated, from an attribute on the 
> +     // entry_ref, and using these to look up a translation in the 
> catalog
> +     // of the top preferred language.
> +
> +     // Attribute format:  "signature:context:string"
> +     // (no colon in any of signature, context and string)
> +
> +     // It fails when a comment is present in the catalog.

Looks nice! Just one suggestion: comments like these don't belong into 
the function body, but should be doxygen comments, ie.:

/*!     Looks up...
        [...]
        It fails when a comment is present in the catalog.
*/
status_t
GetLocalizedFileName(entry_ref& ref, BString& localizedFileName, bool 
traverse)
{
        [...]
}

Bye,
   Axel.


Other related posts: