From e95f9f6875f4cbcae60fe96696eb83a6972bbf26 Mon Sep 17 00:00:00 2001
From: Ben Kaduk <kaduk@mit.edu>
Date: Mon, 15 Oct 2012 14:39:15 -0400
Subject: Massive reST content rename

All of rst_source/ is now just in doc/.
The krb_ prefix is stripped from the document sub-directories.
rst_tools are now just tools.

The section headers of kadmind, krb5kdc, and sserver match as conflict markers.
bigredbutton: whitespace

ticket: 7409
---
 doc/tools/func_document.tmpl | 99 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 99 insertions(+)
 create mode 100644 doc/tools/func_document.tmpl

(limited to 'doc/tools/func_document.tmpl')

diff --git a/doc/tools/func_document.tmpl b/doc/tools/func_document.tmpl
new file mode 100644
index 000000000..b9b63d115
--- /dev/null
+++ b/doc/tools/func_document.tmpl
@@ -0,0 +1,99 @@
+#if $function.short_description is not None
+	#set $title = $function.name + ' - ' + $function.short_description
+#else
+	#set $title = $function.name
+#end if
+$title
+#echo ''.join(['=']*len($title)) #
+
+..
+
+.. c:function:: $signature
+
+..
+
+
+:param:
+
+#for $param in $function.parameters:
+	#if $param.name is ''
+		#continue
+	#end if
+	#if $param.direction is not None
+	    #set name_description = '**[%s]** **%s**' % ($param.direction, $param.name)
+	#else
+	   #set name_description = '**%s**' % $param.name
+	#end if
+	#if $param.description is not None
+	   #set $description= ' - ' + $param.description
+	#else
+	   #set $description=''
+	#end if
+	          $name_description$description
+
+#end for
+
+..
+
+#if len($function.retval_description) > 0
+
+:retval:
+#for $retval in $function.retval_description:
+         - $retval
+#end for
+#end if
+
+#if len($function.return_description) > 0
+
+:return:
+#for $retval in $function.return_description:
+         - $retval
+#end for
+#end if
+
+..
+
+#if $function.deprecated_description is not None
+
+$function.deprecated_description
+#end if
+
+
+
+
+#if $function.long_description is not None
+
+
+$function.long_description
+
+#end if
+
+
+..
+
+#if $function.sa_description is not None
+.. seealso::
+        $function.sa_description
+#end if
+
+
+#if $function.warn_description is not None or  $function.notes_description is not None
+
+
+#if $function.warn_description is not None
+.. warning::
+	$function.warn_description
+#end if
+
+#if $function.notes_description is not None
+.. note::
+	$function.notes_description
+#end if
+
+#end if
+
+#if $function.version_num is not None
+.. note::
+	$function.version_num
+#end if
+
-- 
cgit