sample/template/comment/sh-tmpl.imi

   1
   2
   3 # macro
   4 # enum/union/struct
   5 # typedef
   6 # declare
   7 # variable
   8
   9
  10 # common variable comment
  11
  12 # seperator comment
  13
  14
  15
  16 ################################
  17 # function template
  18 # fcmnt_private_func_list <file-name>
  19 # fcmnt_public_func_list <file-name>
  20 # fcmnt_public_api_list <file-name>
  21 cmnt_private_func='@(fcmnt_tag "example_func" "private" "")
  22 @{cmnt_func_compact_hdr}
  23 @{cmnt_func_name} ()
  24 {
  25         return;
  26 }'
  27
  28 cmnt_public_func='@(fcmnt_tag "example_func" "public" "")
  29 @{cmnt_func_hdr}
  30 @{SRC_NMAE}_@{cmnt_func_name} ()
  31 {
  32         return;
  33 }'
  34
  35 cmnt_public_api='@(fcmnt_tag "example_func" "api" "")
  36 @{cmnt_func_hdr}
  37 API int32 @{SRC_NMAE}ITF_@{cmnt_func_name} (int32 i32Value1)
  38 {
  39         return;
  40 }'
  41
  42 cmnt_test_func='@(fcmnt_tag "testing" "public" "")
  43 @{cmnt_func_compact_hdr}
  44 if false; then
  45 @{SRC_NMAE}_testing ()
  46 {
  47         return;
  48 }
  49 else
  50 @{SRC_NMAE}IF_testing () {}
  51 fi'
  52
  53
  54 ################################
  55 # fcmnt_private_func_extern_list <file-name>
  56 # fcmnt_public_func_extern_list <file-name>
  57 # fcmnt_public_api_extern_list <file-name>
  58
  59 # func_extern
  60 cmnt_public_func_extern=''
  61
  62 # api_extern
  63 cmnt_public_api_extern=''
  64
  65 # testing_extern
  66 cmnt_test_func_extern=''
  67
  68
  69
  70 ################################
  71 # for hdr file
  72
  73 # include
  74 # fcmnt_inc_list <SRC_FNAME>
  75 # fcmnt_inc <name>
  76 # fcmnt_lib_inc <name>
  77 cmnt_inc='include @{FINC_NAME}.shlib'
  78 cmnt_lib_inc='include @{FINC_NAME}.shlib'
  79
  80 # hdr_uniq_begin
  81 cmnt_hdr_uniq_begin='PROG_GVAR_INIT stdio
  82 uniqlib stdio'
  83
  84
  85
  86 # hdr_uniq_end
  87 cmnt_hdr_uniq_end=''
  88
  89
  90 # func_extern_begin
  91 cmnt_func_extern_begin=''
  92
  93 # func_extern_end
  94 cmnt_func_extern_end=''
  95
  96