"Fossies" - the Fresh Open Source Software Archive

Member "krb5-1.18/doc/tools/func_document.tmpl" (12 Feb 2020, 1610 Bytes) of package /linux/misc/krb5-1.18.tar.gz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

    1 #if $function.short_description is not None
    2 	#set $title = $function.name + ' - ' + $function.short_description
    3 #else
    4 	#set $title = $function.name
    5 #end if
    6 $title
    7 #echo ''.join(['=']*len($title)) #
    8 
    9 ..
   10 
   11 .. c:function:: $signature
   12 
   13 ..
   14 
   15 
   16 :param:
   17 
   18 #for $param in $function.parameters:
   19 	#if $param.name is ''
   20 		#continue
   21 	#end if
   22 	#if $param.direction is not None
   23 	    #set name_description = '**[%s]** **%s**' % ($param.direction, $param.name)
   24 	#else
   25 	   #set name_description = '**%s**' % $param.name
   26 	#end if
   27 	#if $param.description is not None
   28 	   #set $description= ' - ' + $param.description
   29 	#else
   30 	   #set $description=''
   31 	#end if
   32 	          $name_description$description
   33 
   34 #end for
   35 
   36 ..
   37 
   38 #if len($function.retval_description) > 0
   39 
   40 :retval:
   41 #for $retval in $function.retval_description:
   42          - $retval
   43 #end for
   44 #end if
   45 
   46 #if len($function.return_description) > 0
   47 
   48 :return:
   49 #for $retval in $function.return_description:
   50          - $retval
   51 #end for
   52 #end if
   53 
   54 ..
   55 
   56 #if $function.deprecated_description is not None
   57 
   58 $function.deprecated_description
   59 #end if
   60 
   61 
   62 
   63 
   64 #if $function.long_description is not None
   65 
   66 
   67 $function.long_description
   68 
   69 #end if
   70 
   71 
   72 ..
   73 
   74 #if $function.sa_description is not None
   75 .. seealso::
   76         $function.sa_description
   77 #end if
   78 
   79 
   80 #if $function.warn_description is not None or  $function.notes_description is not None
   81 
   82 
   83 #if $function.warn_description is not None
   84 .. warning::
   85 
   86 	$function.warn_description
   87 #end if
   88 
   89 #if $function.notes_description is not None
   90 .. note::
   91 
   92 	$function.notes_description
   93 #end if
   94 
   95 #end if
   96 
   97 #if $function.version_num is not None
   98 .. note::
   99 
  100 	$function.version_num
  101 #end if
  102