converted comments to get caught by doxygen

[citadel.git] / webcit / calendar_tools.c

diff --git a/webcit/calendar_tools.c b/webcit/calendar_tools.c
index 3fbab7eec1740aca5ef05df76bbf1ab3896c0833..be8e16f98f45f4dc66c02e5f520230d6a0778713 100644 (file)
--- a/webcit/calendar_tools.c
+++ b/webcit/calendar_tools.c
@@ -1,14 +1,16 @@
 /*
  * $Id$
- *
- * Miscellaneous functions which handle calendar components.
  */
-
+/**
+ * \defgroup MiscCal Miscellaneous functions which handle calendar components.
+ */
+/*@{*/
 #include "webcit.h"
 #include "webserver.h"
 
-/* FIXME ... this needs to be internationalized */
-char *months[] = {
+/* \todo FIXME ... this needs to be internationalized */
+/** Month Strings. */
+char *months[] = { 
        "January",
        "February",
        "March",
@@ -23,7 +25,8 @@ char *months[] = {
        "December"
 };
 
-char *days[] = {
+/** Day Strings */
+char *days[] = { 
        "Sunday",
        "Monday",
        "Tuesday",
@@ -33,6 +36,7 @@ char *days[] = {
        "Saturday"
 };
 
+/** Hour strings */
 char *hourname[] = {
        "12am", "1am", "2am", "3am", "4am", "5am", "6am",
        "7am", "8am", "9am", "10am", "11am", "12pm",
@@ -42,7 +46,8 @@ char *hourname[] = {
 
 #ifdef WEBCIT_WITH_CALENDAR_SERVICE
 
-/*
+/**
+ * \brief display and edit date/time
  * The display_icaltimetype_as_webform() and icaltime_from_webform() functions
  * handle the display and editing of date/time properties in web pages.  The
  * first one converts an icaltimetype into valid HTML markup -- a series of form
@@ -53,10 +58,12 @@ char *hourname[] = {
  * property (for example, a start and end time) by ensuring the field names are
  * unique within the form.
  *
- * NOTE: These functions assume that the icaltimetype being edited is in UTC, and
+ * \todo NOTE: These functions assume that the icaltimetype being edited is in UTC, and
  * will convert to/from local time for editing.  "local" in this case is assumed
  * to be the time zone in which the WebCit server is running.  A future improvement
  * might be to allow the user to specify his/her timezone.
+ * \param t the time we want to parse
+ * \param prefix ???? \todo
  */
 
 
@@ -159,7 +166,12 @@ void display_icaltimetype_as_webform(struct icaltimetype *t, char *prefix) {
        wprintf("</SELECT>\n");
 }
 
-
+/**
+ *\brief Get time from form
+ * get the time back from the user and convert it into internal structs.
+ * \param t our time element
+ * \param prefix whats that\todo ????
+ */
 void icaltime_from_webform(struct icaltimetype *t, char *prefix) {
        char vname[32];
         time_t tt;
@@ -180,6 +192,12 @@ void icaltime_from_webform(struct icaltimetype *t, char *prefix) {
        memcpy(t, &t2, sizeof(struct icaltimetype));
 }
 
+/**
+ *\brief Get time from form
+ * get the time back from the user and convert it into internal structs.
+ * \param t our time element
+ * \param prefix whats that\todo ????
+ */
 
 void icaltime_from_webform_dateonly(struct icaltimetype *t, char *prefix) {
        char vname[32];
@@ -194,8 +212,11 @@ void icaltime_from_webform_dateonly(struct icaltimetype *t, char *prefix) {
 }
 
 
-/*
+/**
+ * \brief Render PAPSTAT
  * Render a PARTSTAT parameter as a string (and put it in parentheses)
+ * \param buf the string to put it to
+ * \param attendee the attendee to textify
  */
 void partstat_as_string(char *buf, icalproperty *attendee) {
        icalparameter *partstat_param;
@@ -244,8 +265,11 @@ void partstat_as_string(char *buf, icalproperty *attendee) {
 }
 
 
-/*
+/**
+ * \brief embedd
  * Utility function to encapsulate a subcomponent into a full VCALENDAR
+ * \param subcomp the component to encapsulate
+ * \returns the meta object ???
  */
 icalcomponent *ical_encapsulate_subcomponent(icalcomponent *subcomp) {
        icalcomponent *encaps;
@@ -257,14 +281,15 @@ icalcomponent *ical_encapsulate_subcomponent(icalcomponent *subcomp) {
                return NULL;
        }
 
-       /* If we're already looking at a full VCALENDAR component,
+       /**
+        * If we're already looking at a full VCALENDAR component,
         * don't bother ... just return itself.
         */
        if (icalcomponent_isa(subcomp) == ICAL_VCALENDAR_COMPONENT) {
                return subcomp;
        }
 
-       /* Encapsulate the VEVENT component into a complete VCALENDAR */
+       /** Encapsulate the VEVENT component into a complete VCALENDAR */
        encaps = icalcomponent_new(ICAL_VCALENDAR_COMPONENT);
        if (encaps == NULL) {
                lprintf(3, "%s:%d: Error - could not allocate component!\n",
@@ -272,22 +297,22 @@ icalcomponent *ical_encapsulate_subcomponent(icalcomponent *subcomp) {
                return NULL;
        }
 
-       /* Set the Product ID */
+       /** Set the Product ID */
        icalcomponent_add_property(encaps, icalproperty_new_prodid(PRODID));
 
-       /* Set the Version Number */
+       /** Set the Version Number */
        icalcomponent_add_property(encaps, icalproperty_new_version("2.0"));
 
-       /* Encapsulate the subcomponent inside */
+       /** Encapsulate the subcomponent inside */
        /* lprintf(9, "Doing the encapsulation\n"); */
        icalcomponent_add_component(encaps, subcomp);
 
-       /* Convert all timestamps to UTC so we don't have to deal with
+       /** Convert all timestamps to UTC so we don't have to deal with
         * stupid VTIMEZONE crap.
         */
        ical_dezonify(encaps);
 
-       /* Return the object we just created. */
+       /** Return the object we just created. */
        return(encaps);
 }
 
@@ -295,3 +320,4 @@ icalcomponent *ical_encapsulate_subcomponent(icalcomponent *subcomp) {
 
 
 #endif
+/*@}*/