mk/su-doxygen.rc

   1 #@ SU: doxygen(1) configuration
   2
   3 PROJECT_NAME = S-nail
   4 PROJECT_NUMBER = 14.9.12
   5 PROJECT_BRIEF = "Send and receive Internet mail"
   6 INPUT = include/su
   7 EXCLUDE_PATTERNS = gen-*.*
   8 OUTPUT_DIRECTORY = .doc
   9 #OPTIMIZE_OUTPUT_FOR_C = YES
  10 HIDE_UNDOC_MEMBERS = YES
  11 SHOW_INCLUDE_FILES = NO
  12 MAX_INITIALIZER_LINES = 0
  13 MACRO_EXPANSION = YES
  14 #SKIP_FUNCTION_MACROS = NO
  15 # Grrr: cannot include code-in.h, need to defined ALL the stuff again??!
  16 # Define CXX_DOXYGEN to include C++ docu
  17 PREDEFINED = DOXYGEN CXX_DOXYGEN \
  18         \
  19         su_HAVE_DEBUG \
  20         su_HAVE_DEVEL \
  21         su_HAVE_MEM_BAG_AUTO \
  22         su_HAVE_MEM_BAG_LOFI \
  23         su_HAVE_MEM_CANARIES_DISABLE \
  24         \
  25         __STDC_VERSION__=999912L C_LANG \
  26         C_DECL_BEGIN C_DECL_END NSPC_BEGIN NSPC_END \
  27         EXPORT EXPORT_DATA SINLINE INLINE \
  28         su_DBG_LOC_ARGS_DECL= su_DBG_LOC_ARGS_DECL_SOLE= \
  29         CTA(X)= MCTA(X)= NSPC(X)= \
  30         u8:=su_u8 s8:=su_s8 u16:=su_u16 s16:=su_s16 \
  31         u32:=su_u32 s32:=su_s32 u64:=su_u64 s64:=su_s64 \
  32         uz:=su_uz sz:=su_sz up:=su_up sp:=su_sp \
  33         boole:=su_boole \
  34
  35 #EXPAND_ONLY_PREDEF = YES
  36 #-> EXPAND_AS_DEFINED = C_DECL_BEGIN EXPORT EXPORT_DATA
  37 #RECURSIVE = YES
  38 INLINE_GROUPED_CLASSES = YES
  39 INLINE_SIMPLE_STRUCTS  = YES
  40 GROUP_NESTED_COMPOUNDS = YES
  41 REPEAT_BRIEF = YES
  42 SHORT_NAMES = YES
  43 #GENERATE_HTML = YES
  44 HTML_DYNAMIC_MENUS = NO
  45 HTML_DYNAMIC_SECTIONS = YES
  46 GENERATE_LATEX = NO
  47 #GENERATE_MAN = yes
  48 ##
  49 #ALIASES += test{1}="\ref \1"
  50 #-> \test{ARG}
  51 #ALIASES += test{2}="\ref \1 \"\2\""
  52 #-> \test{ARG,some text} [this overloads \test!]
  53 #ALIASES += title{1}=
  54 # NOTE: we need the HTML tags since doxygen will merge "\r{BLA}." to
  55 # "\ref BLA.", i.e., we need to somehow inject a separator!
  56 ALIASES += SU="<span>\em SU</span>"
  57 ALIASES += SELF="<span>\em self</span>"
  58 ALIASES += THIS="<span>\em this</span>"
  59 ALIASES += NIL="\r{su_NIL}"
  60 ALIASES += FAL0="\r{su_FAL0}"
  61 ALIASES += TRU1="\r{su_TRU1}"
  62 ALIASES += TRUM1="\r{su_TRUM1}"
  63 ALIASES += ASSERT{2}="Debug-assertion: returns \1 if \2."
  64 ALIASES += a{1}="<span>\a \1</span>"
  65 ALIASES += c{1}="<span>\c \1</span>"
  66 ALIASES += cb{1}="<div>\code \1\endcode</div>"
  67 ALIASES += copydoc{1}="\r{\1}:&nbsp; \copydoc \1 &nbsp;"
  68 ALIASES += ERR{1}="\c{su_ERR_\1} (\r{su_err_number})"
  69 ALIASES += err{1}="\c{err::\1} (\r{err})"
  70 ALIASES += fn{1}="\c{\1}"
  71 ALIASES += head1{1}="\par \1^^"
  72 ALIASES += head2{1}="\par \1^^"
  73 ALIASES += li{1}="\li \pb{\1}"
  74 ALIASES += list{1}="<div>\1</div>"
  75 ALIASES += ln{1}="<span>\link \1\endlink</span>"
  76 ALIASES += pb{1}="<div>\parblock \1\endparblock</div>"
  77 ALIASES += r{1}="<span>\ref \1</span>"
  78 ALIASES += remarks{1}="\remarks <div>\parblock \1\endparblock</div>"
  79 ALIASES += vr{1}="\c{\1}"
  80 ALIASES += xln{1}="\c{\1}"