From 29400c568a84339066ef238e836cfeb19f732873 Mon Sep 17 00:00:00 2001 From: Zolnai Tamás Date: Thu, 2 May 2013 15:06:23 +0200 Subject: Some code scrubing Add doxygen documentation for classes and methods Delete useless comments. Add include guards where missing. Delete some useless typedef. Change-Id: I9bba16560790239d7775fcd40981465e70e5d437 --- l10ntools/inc/common.hxx | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) (limited to 'l10ntools/inc/common.hxx') diff --git a/l10ntools/inc/common.hxx b/l10ntools/inc/common.hxx index 93f2d008cb82..5a12bbbbebe4 100644 --- a/l10ntools/inc/common.hxx +++ b/l10ntools/inc/common.hxx @@ -7,7 +7,7 @@ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ -/// Methods used by all of executables +// Methods used by all of executables #ifndef INCLUDED_L10NTOOLS_SOURCE_COMMON_HXX #define INCLUDED_L10NTOOLS_SOURCE_COMMON_HXX @@ -20,7 +20,7 @@ namespace common { -//result type of handleArguments() +/// Result type of handleArguments() struct HandledArgs { OString m_sInputFile; @@ -37,10 +37,13 @@ struct HandledArgs {} }; +/// Handle command line parameters bool handleArguments(int argc, char * argv[], HandledArgs& o_aHandledArgs); +/// Write out a help about usage void writeUsage(const OString& rName, const OString& rFileType); +/// Write out a PoEntry with attention to excaptions void writePoEntry( const OString& rExecutable, PoOfstream& rPoStream, const OString& rSourceFile, const OString& rResType, const OString& rGroupId, const OString& rLocalId, -- cgit