[asterisk-commits] twilson: branch twilson/calendaring r160443 - in /team/twilson/calendaring: i...

[SVN commits to the Asterisk project]

Author: twilson
Date: Tue Dec  2 23:02:19 2008
New Revision: 160443

URL: http://svn.digium.com/view/asterisk?view=rev&rev=160443
Log:
Add more doxygen docs for russell (and change ast_calendar_merge_events to return void since it always returned 0 and I never check the return value)

Modified:
    team/twilson/calendaring/include/asterisk/calendar.h
    team/twilson/calendaring/main/calendar.c

Modified: team/twilson/calendaring/include/asterisk/calendar.h
URL: http://svn.digium.com/view/asterisk/team/twilson/calendaring/include/asterisk/calendar.h?view=diff&rev=160443&r1=160442&r2=160443
==============================================================================
--- team/twilson/calendaring/include/asterisk/calendar.h (original)
+++ team/twilson/calendaring/include/asterisk/calendar.h Tue Dec  2 23:02:19 2008
@@ -127,25 +127,55 @@
 	struct ao2_container *events;  /*!< The events that are known at this time */
 };
 
-/*! \brief Register a new calendar technology */
+/*! \brief Register a new calendar technology
+ *
+ * \param tech calendar technology to register
+ *
+ * \return Returns 0 on success, -1 on failure
+ */
 int ast_calendar_register(const struct ast_calendar_tech *tech);
 
-/*! \brief Unregister a new calendar technology */
+/*! \brief Unregister a new calendar technology
+ *
+ * \param tech calendar technology to unregister
+ *
+ * \return Returns 0 on success, -1 on failure
+ */
 void ast_calendar_unregister(const struct ast_calendar_tech *tech);
 
-/*! \brief Allocate an astobj2 ast_calendar_event object */
+/*! \brief Allocate an astobj2 ast_calendar_event object
+ *
+ * \param cal calendar to allocate an event for
+ *
+ * \return a new, initialized calendar event
+ */
 struct ast_calendar_event *ast_calendar_event_alloc(struct ast_calendar *cal);
 
-/*! \brief Allocate an astobj2 container for ast_calendar_event objects */
+/*! \brief Allocate an astobj2 container for ast_calendar_event objects
+ *
+ * \return a new event container
+ */
 struct ao2_container *ast_calendar_event_container_alloc(void);
 
-/*! \brief Add an event to the list of events for a calendar */
-int ast_calendar_merge_events(struct ast_calendar *cal, struct ao2_container *new_events);
+/*! \brief Add an event to the list of events for a calendar
+ *
+ * \param cal calendar containing the events to be merged
+ * \param new_events an oa2 container of events to be merged into cal->events
+ */
+void ast_calendar_merge_events(struct ast_calendar *cal, struct ao2_container *new_events);
 
-/*! \brief Unreference an ast_calendar_event */
+/*! \brief Unreference an ast_calendar_event 
+ *
+ * \param event event to unref
+ *
+ * \return NULL
+ */
 struct ast_calendar_event *ast_calendar_unref_event(struct ast_calendar_event *event);
 
-/*! \brief Remove all events from calendar */
+/*! \brief Remove all events from calendar 
+ *
+ * \param cal calendar whose events need to be cleared
+ */
 void ast_calendar_clear_events(struct ast_calendar *cal);
 
 #endif /* _ASTERISK_CALENDAR_H */

Modified: team/twilson/calendaring/main/calendar.c
URL: http://svn.digium.com/view/asterisk/team/twilson/calendaring/main/calendar.c?view=diff&rev=160443&r1=160442&r2=160443
==============================================================================
--- team/twilson/calendaring/main/calendar.c (original)
+++ team/twilson/calendaring/main/calendar.c Tue Dec  2 23:02:19 2008
@@ -494,7 +494,7 @@
 	return 0;
 }
 
-int ast_calendar_merge_events(struct ast_calendar *cal, struct ao2_container *new_events)
+void ast_calendar_merge_events(struct ast_calendar *cal, struct ao2_container *new_events)
 {
 	struct ao2_iterator i;
 	struct ast_calendar_event *old_event, *new_event;