[asterisk-commits] twilson: branch twilson/calendaring r182447 - /team/twilson/calendaring/main/

SVN commits to the Asterisk project asterisk-commits at lists.digium.com
Tue Mar 17 00:05:43 CDT 2009


Author: twilson
Date: Tue Mar 17 00:05:34 2009
New Revision: 182447

URL: http://svn.digium.com/svn-view/asterisk?view=rev&rev=182447
Log:
Convert docs to xmldocs

Modified:
    team/twilson/calendaring/main/calendar.c

Modified: team/twilson/calendaring/main/calendar.c
URL: http://svn.digium.com/svn-view/asterisk/team/twilson/calendaring/main/calendar.c?view=diff&rev=182447&r1=182446&r2=182447
==============================================================================
--- team/twilson/calendaring/main/calendar.c (original)
+++ team/twilson/calendaring/main/calendar.c Tue Mar 17 00:05:34 2009
@@ -39,6 +39,120 @@
 #include "asterisk/pbx.h"
 #include "asterisk/app.h"
 
+/*** DOCUMENTATION
+	<function name="CALENDAR_BUSY" language="en_US">
+		<synopsis>
+			Determine if the calendar is marked busy at this time.
+		</synopsis>
+		<syntax>
+			<parameter name="calendar" required="true" />
+		</syntax>
+    	<description>
+			<para>Check the specified calendar's current busy status.</para>
+		</description>
+	</function>
+	<function name="CALENDAR_EVENT" language="en_US">
+		<synopsis>
+			Get calendar event notification data from a notification call.
+		</synopsis>
+		<syntax>
+			<parameter name="field" required="true">
+				<enumlist>
+					<enum name="summary"><para>The VEVENT SUMMARY property or Exchange event 'subject'</para></enum>
+					<enum name="description"><para>The text description of the event</para></enum>
+					<enum name="organizer"><para>The organizer of the event</para></enum>
+					<enum name="location"><para>The location of the eventt</para></enum>
+					<enum name="calendar"><para>The name of the calendar associated with the event</para></enum>
+					<enum name="uid"><para>The unique identifier for this event</para></enum>
+					<enum name="start"><para>The start time of the event</para></enum>
+					<enum name="end"><para>The end time of the event</para></enum>
+					<enum name="busystate"><para>The busy state of the event 0=FREE, 1=TENTATIVE, 2=BUSY</para></enum>
+				</enumlist>
+			</parameter>
+		</syntax>
+		<description>
+			<para>Whenever a calendar event notification call is made, the event data
+			may be accessed with this function.</para>
+		</description>
+	</function>
+	<function name="CALENDAR_QUERY" language="en_US">
+		<synopsis>Query a calendar server and store the data on a channel
+		</synopsis>
+		<syntax>
+			<parameter name="calendar" required="true">
+				<para>The calendar that should be queried</para>
+			</parameter>
+			<parameter name="start" required="false">
+				<para>The start time of the query (in seconds since epoch)</para>
+			</parameter>
+			<parameter name="end" required="false">
+				<para>The end time of the query (in seconds since epoch)</para>
+			</parameter>
+		</syntax>
+		<description>
+			<para>Get a list of events in the currently accessible timeframe of the <replaceable>calendar</replaceable>
+			The function returns the id for accessing the result with CALENDAR_QUERY_RESULT()</para>
+		</description>
+	</function>
+	<function name="CALENDAR_QUERY_RESULT" language="en_US">
+		<synopsis>
+			Retrieve data from a previously run CALENDAR_QUERY() call
+		</synopsis>
+		<syntax>
+			<parameter name="id" required="true">
+				<para>The query ID returned by <literal>CALENDAR_QUERY</literal></para>
+			</parameter>
+			<parameter name="field" required="true">
+				<enumlist>
+					<enum name="getnum"><para>number of events occurring during time range</para></enum>
+					<enum name="summary"><para>A summary of the event</para></enum>
+					<enum name="description"><para>The full event description</para></enum>
+					<enum name="organizer"><para>The event organizer</para></enum>
+					<enum name="location"><para>The event location</para></enum>
+					<enum name="calendar"><para>The name of the calendar associted with the event</para></enum>
+					<enum name="uid"><para>The unique identifier for the event</para></enum>
+					<enum name="start"><para>The start time of the event (in seconds since epoch)</para></enum>
+					<enum name="end"><para>The end time of the event (in seconds since epoch)</para></enum>
+					<enum name="busystate"><para>The busy status of the event 0=FREE, 1=TENTATIVE, 2=BUSY</para></enum>
+				</enumlist>
+			</parameter>
+			<parameter name="entry" required="false" default="1">
+				<para>Return data from a specific event returned by the query</para>
+			</parameter>
+		</syntax>
+		<description>
+			<para>After running CALENDAR_QUERY and getting a result <replaceable>id</replaceable>, calling
+			<literal>CALENDAR_QUERY</literal> with that <replaceable>id</replaceable> and a <replaceable>field</replaceable>
+			will return the data for that field. If multiple events matched the query, and <replaceable>entry</replaceable>
+			is provided, information from that event will be returned.</para>
+		</description>
+	</function>
+	<function name="CALENDAR_WRITE" language="en_US">
+		<synopsis>Write an event to a calendar</synopsis>
+		<syntax>
+			<parameter name="calendar" required="true">
+				<para>The calendar to write to</para>
+			</parameter>
+			<parameter name="field" multiple="true" required="true">
+				<enumlist>
+					<enum name="summary"><para>A summary of the event</para></enum>
+					<enum name="description"><para>The full event description</para></enum>
+					<enum name="organizer"><para>The event organizer</para></enum>
+					<enum name="location"><para>The event location</para></enum>
+					<enum name="uid"><para>The unique identifier for the event</para></enum>
+					<enum name="start"><para>The start time of the event (in seconds since epoch)</para></enum>
+					<enum name="end"><para>The end time of the event (in seconds since epoch)</para></enum>
+					<enum name="busystate"><para>The busy status of the event 0=FREE, 1=TENTATIVE, 2=BUSY</para></enum>
+				</enumlist>
+			</parameter>
+		</syntax>
+		<description>
+			<para>Example: CALENDAR_WRITE(calendar,field1,field2,field3)=val1,val2,val3</para>
+			<para>The field and value arguments can easily be set/passed using the HASHKEYS() and HASH() functions</para>
+		</description>
+	</function>
+
+***/
 #define MAX_BUCKETS 19
 
 static struct ao2_container *calendars;
@@ -770,10 +884,6 @@
 
 static struct ast_custom_function calendar_busy_function = {
     .name = "CALENDAR_BUSY",
-    .synopsis = "Determine if the calendar is marked busy at this time",
-    .syntax = "CALENDAR_BUSY(<calendar_name>)",
-    .desc =
-        "Check the specified calendar's current busy status",
     .read = calendar_busy_exec,
 };
 
@@ -952,13 +1062,6 @@
 
 static struct ast_custom_function calendar_query_function = {
     .name = "CALENDAR_QUERY",
-    .synopsis = "Query a calendar server and store the data on a channel.\n"
-	            "Return the id for accessing the result with CALENDAR_QUERY_RESULT()\n",
-    .syntax = "CALENDAR_QUERY(<calendar>[,<start>][,<end>])",
-    .desc = "Options:\n"
-	        "  <calendar> : A named calendar entry in the calendar.conf file\n"
-			"  <start>    : The start time of the query (in seconds since epoch)\n"
-			"  <end>      : The end time of the query (in seconds since epoch)\n",
     .read = calendar_query_exec,
 };
 
@@ -1036,21 +1139,6 @@
 
 static struct ast_custom_function calendar_query_result_function = {
 	.name = "CALENDAR_QUERY_RESULT",
-	.synopsis = "Retrieve data from a previously run CALENDAR_QUERY() call",
-	.syntax = "CALENDAR_QUERY_RESULT(<id>,<field>[,<n>])",
-	.desc = "Options:\n"
-	        "  <field>    : Specific information about a particular event\n"
-	        "    getnum      = number of events occurring during time range\n"
-			"    summary     = A summary of the event\n"
-			"    description = The full event description\n"
-			"    organizer   = The event organizer\n"
-			"    location    = The event location\n"
-			"    calendar    = The name of the calendar associted with the event\n"
-			"    uid         = The unique identifier for the event\n"
-			"    start       = The start time of the event (in seconds since epoch)\n"
-			"    end         = The end time of the event (in seconds since epoch)\n"
-			"    busystate   = The busy status of the event 0=FREE, 1=TENTATIVE, 2=BUSY\n"
-			"  <n>       : The nth event (starting at 1) returned by the query\n",
 	.read = calendar_query_result_exec,
 };
 
@@ -1145,21 +1233,6 @@
 
 static struct ast_custom_function calendar_write_function = {
 	.name = "CALENDAR_WRITE",
-	.synopsis = "Write an event to a calendar",
-	.syntax = "CALENDAR_WRITE(<calendar>,<field1>[,<field2>][,...<fieldn>])=<value1>[,<value2>][,...<fieldn>]",
-	.desc = "Options:\n"
-	        "  <calendar> : The name of the calendar, or a calendar URI\n"
-	        "  <field>    : Specific information about a particular event\n"
-			"    summary     = A summary of the event\n"
-			"    description = The full event description\n"
-			"    organizer   = The event organizer\n"
-			"    location    = The event location\n"
-			"    uid         = The unique identifier for the event\n"
-			"    start       = The start time of the event (in seconds since epoch)\n"
-			"    end         = The end time of the event (in seconds since epoch)\n"
-			"    busystate   = The busy status of the event 0=FREE, 1=TENTATIVE, 2=BUSY\n"
-			"\n"
-			"The field and value arguments can easily be set/passed using the HASHKEYS() and HASH() functions\n",
 	.write = calendar_write_exec,
 };
 
@@ -1359,19 +1432,6 @@
 
 static struct ast_custom_function calendar_event_function = {
 	.name = "CALENDAR_EVENT",
-	.synopsis = "Gets calendar event notification data from a notification call",
-	.syntax = "CALENDAR_EVENT(<field>)",
-	.desc = "Whenever a calendar event notification call is made, the event data\n"
-	        "may be accessed with this function. Valid field names are:\n"
-	        "summary     : The VEVENT SUMMARY property or Exchange event 'subject'\n"
-	        "description : The text description of the event\n"
-	        "organizer   : The organizer of the event\n"
-	        "location    : The location of the eventt\n"
-	        "calendar    : The name of the calendar associated with the event\n"
-	        "uid         : The unique identifier for this event\n"
-	        "start       : The start time of the event\n"
-	        "end         : The end time of the event\n"
-	        "busystate   : The busy state of the event 0=FREE, 1=TENTATIVE, 2=BUSY\n",
 	.read = calendar_event_read,
 };
 




More information about the asterisk-commits mailing list