From: vsr <vsr@opencascade.com>
Date: Tue, 27 Aug 2013 09:52:08 +0000 (+0000)
Subject: Improve documentation for some macros SALOME_JUSTIFY_STRING() and SALOME_PACKAGE_REPO... 
X-Git-Tag: begin_agr_portmanager_branch_131004~40
X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=0817e9f7093a2e13025fee69aeb9f4628c0831ad;p=modules%2Fkernel.git

Improve documentation for some macros SALOME_JUSTIFY_STRING() and SALOME_PACKAGE_REPORT() macros
---

diff --git a/salome_adm/cmake_files/SalomeMacros.cmake b/salome_adm/cmake_files/SalomeMacros.cmake
index c06eac91b..bcdf88c59 100755
--- a/salome_adm/cmake_files/SalomeMacros.cmake
+++ b/salome_adm/cmake_files/SalomeMacros.cmake
@@ -254,6 +254,14 @@ ENDMACRO(SALOME_UPDATE_FLAG_AND_LOG_PACKAGE)
 # adding required number of spaces to the end. Does noting if input
 # string is longer as required length.
 # Puts the result to the output variable.
+#
+# USAGE: SALOME_JUSTIFY_STRING(input length result)
+#
+# ARGUMENTS:
+#   input  [in] input string
+#   length [in] required length of resulting string
+#   result [out] name of variable where the result string is put to
+#
 MACRO(SALOME_JUSTIFY_STRING input length result)
   SET(${result} ${input})
   STRING(LENGTH ${input} _input_length)
@@ -269,11 +277,16 @@ ENDMACRO(SALOME_JUSTIFY_STRING)
 # SALOME_PACKAGE_REPORT()
 #
 # Print a quick summary of the detection of optional prerequisites.
+# 
+# If optional JUSTIFY argument is specified, names of packages
+# are left-justified to the given length; default value is 10.
+#
+# USAGE: SALOME_PACKAGE_REPORT([JUSTIFY length])
 #
 MACRO(SALOME_PACKAGE_REPORT)
-  PARSE_ARGUMENTS(SALOME_PACKAGE_REPORT "LENGTH" "" ${ARGN})
-  IF(SALOME_PACKAGE_REPORT_LENGTH)
-    SET(_length ${SALOME_PACKAGE_REPORT_LENGTH})
+  PARSE_ARGUMENTS(SALOME_PACKAGE_REPORT "JUSTIFY" "" ${ARGN})
+  IF(SALOME_PACKAGE_REPORT_JUSTIFY)
+    SET(_length ${SALOME_PACKAGE_REPORT_JUSTIFY})
   ELSE()
     SET(_length 10)
   ENDIF()