sample/template/general/need-info.txt

   1
   2 ##############################################
   3 # for author
   4 @{AUTHOR}
   5
   6 ##############################################
   7 # for srcpkg
   8 @{PROJECT}
   9 @{COMPANY_EN}
  10 @{CITY_EN}
  11 @{COUNTRY_EN}
  12 @{COMPANY_CN}
  13 @{CITY_CN}
  14 @{COUNTRY_CN}
  15
  16 txt_width: width for dispalying. normally it's 80 ascii char width in tty.
  17
  18 #lisence: lisence conent for every file.
  19 # instead with this. different code type uses different lisence.
  20 compact_lisence_file
  21
  22
  23
  24
  25
  26
  27 ##############################################
  28 # for src file
  29 @{SRC_TYPE}
  30 @{SRC_SFX}
  31 @{SRC_NAME}
  32 @{SRC_FNAME}
  33 @{DATE}
  34 FILE_NOTE: note for current file.
  35 FIRST_MODIFY_NOTE:
  36 interpreter:
  37 paramter:
  38 srctp:
  39 srcchksum:
  40 src_file_note: for current src file module description.
  41
  42 ##############################################
  43 # for func
  44 cmnt_func_name:
  45 cmnt_func_desc:
  46 cmnt_func_param_num:
  47 cmnt_func_param_desc[]:
  48 cmnt_func_param_name[]:
  49 cmnt_func_return:
  50
  51
  52
  53
  54
  55
  56 ##############################################
  57 # template functions
  58 fsrc_lisence()
  59 fcmnt_body()
  60 fcmnt_funclist()
  61 fcmnt_func_desc()
  62
  63 fcmnt_private_func_list()
  64 fcmnt_public_func_list()
  65 fcmnt_public_api_list()
  66 fcmnt_test_func()
  67
  68 fcmnt_private_func_extern_list()
  69 fcmnt_public_func_extern_list()
  70 fcmnt_public_api_extern_list()
  71
  72 fcmnt_upper()
  73 fcmnt_lower()
  74
  75 fcmnt_inc_list()
  76 fcmnt_inc()
  77 fcmnt_lib_inc()
  78