adding func doc.

diff --git a/main/buassert.fnc b/main/buassert.fnc
index a95c444..a4e2092 100644 (file)
--- a/main/buassert.fnc
+++ b/main/buassert.fnc
@@ -2,12 +2,10 @@
 # @(#) buassert.fnc ver20140130
 #
 # Description:
-#   Functions for logging messages.
+#   Functions for assert.
 #
 # @author Toshiki IGA <tosiki.iga@nifty.ne.jp>
 # @version 1.0 2014-01-29 created newly.
-#####################################################################
-
 ##############################################################################
 
 ##############################################################################

diff --git a/main/bumsg.fnc b/main/bumsg.fnc
index c0a2ea4..e387f1b 100644 (file)
--- a/main/bumsg.fnc
+++ b/main/bumsg.fnc
@@ -44,10 +44,18 @@
 
 LOGGER="/usr/bin/logger -t $0 -i"
 
-# write message to log
+########################################
+# Write message to specified media.
+#
 # @param $1 message id
 # @param $2 argument 1
 # @param $3 argument 2
+# @param $4 argument 3
+# @param $5 argument 4
+# @param $6 argument 5
+# @param $7 argument 6
+# @param $8 argument 7
+# @param $9 argument 8
 logmsg() {
   local msgid=$1
   local strmsg="`getmsg $1 $2 $3 $4 $5 $6 $7 $8 $9`"
@@ -72,6 +80,19 @@ logmsg() {
   return 0
 }
 
+########################################
+# Get message from message environment.
+#
+# @param $1 message id
+# @param $2 argument 1
+# @param $3 argument 2
+# @param $4 argument 3
+# @param $5 argument 4
+# @param $6 argument 5
+# @param $7 argument 6
+# @param $8 argument 7
+# @param $9 argument 8
+# @echo message text
 getmsg() {
   local msgid=$1
   local arg1=$2
@@ -99,6 +120,11 @@ getmsg() {
   return 0
 }
 
+########################################
+# Get message id environment key.
+#
+# @param $1 message id
+# @echo message id environment key
 getmsgIdEnvKey() {
   local msgid=$1
   local msgtextkey='${MSG_'${msgid}'}'
@@ -106,6 +132,11 @@ getmsgIdEnvKey() {
   return 0
 }
 
+########################################
+# Get message environment value.
+#
+# @param $1 environment key
+# @echo message environment value
 getmsgEnvValue() {
   local envkey=$1
   local msgtextkeyString="`eval \"echo ${envkey}\"`"
@@ -113,6 +144,10 @@ getmsgEnvValue() {
   return 0
 }
 
+########################################
+# Get message environment boolean value.
+#
+# @param $1 environment key
 # @return 0:true 1:false 2:unknown
 getmsgEnvBooleanValue() {
   local envkey="$1"
@@ -138,6 +173,11 @@ getmsgEnvBooleanValue() {
   return 2
 }
 
+########################################
+# Check write sysout or not.
+#
+# @param $1 message id
+# @return 0:do output 1:none
 ismsgEnvSysout() {
   local msgid="$1"
   local envkey="`getmsgIdEnvKey ${msgid}'_sysout'`"
@@ -151,6 +191,11 @@ ismsgEnvSysout() {
   esac
 }
 
+########################################
+# Check write syserr or not.
+#
+# @param $1 message id
+# @return 0:do output 1:none
 ismsgEnvSyserr() {
   local msgid="$1"
   local envkey="`getmsgIdEnvKey ${msgid}'_syserr'`"
@@ -164,6 +209,11 @@ ismsgEnvSyserr() {
   esac
 }
 
+########################################
+# Check write logger(syslog) or not.
+#
+# @param $1 message id
+# @return 0:do output 1:none
 ismsgEnvLogger() {
   local msgid="$1"
   local envkey="`getmsgIdEnvKey ${msgid}'_logger'`"
@@ -177,6 +227,11 @@ ismsgEnvLogger() {
   esac
 }
 
+########################################
+# Check embed message id or not.
+#
+# @param $1 message id
+# @return 0:do output 1:none
 ismsgEnvEmbedid() {
   local msgid="$1"
   local envkey="`getmsgIdEnvKey ${msgid}'_embedid'`"