Enlightenment CVS committal
Author : lordchaos
Project : e17
Module : libs/ewl
Dir : e17/libs/ewl/src/lib
Modified Files:
ewl_calendar.c ewl_calendar.h
Log Message:
Cleaned up documentation on ewl_calendar
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/lib/ewl_calendar.c,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -3 -r1.1 -r1.2
--- ewl_calendar.c 10 Jul 2005 08:18:05 -0000 1.1
+++ ewl_calendar.c 10 Jul 2005 08:26:37 -0000 1.2
@@ -105,6 +105,14 @@
ewl_widget_show(day_label);
}
+/**
+ * @param cal: The calendar to get the date frm
+ * @param str: a pre-initialized char* pointer to insert the date into
+ * @return none
+ * @brief Returns an ASCII formatted representation of the selected date
+ *
+ * Inserts an ASCII formatted string of the currently selected date into the
char* str pointer
+ */
void ewl_calendar_ascii_time_get(Ewl_Calendar* cal, char* str) {
time_t tm;
struct tm* month_start;
@@ -203,8 +211,10 @@
/**
- * @return Returns NULL on failure, a new Ewl_IconBox on success
- * @brief Creates a new Ewl_IconBox
+ * @return Returns NULL on failure, a new Ewl_Calendar on success
+ * @brief Creates a new Ewl_Calendar
+ *
+ * Creates a new Ewl_Calendar object
*/
Ewl_Widget *ewl_calendar_new() {
Ewl_Calendar* ib;
@@ -216,7 +226,7 @@
}
if (!ewl_calendar_init(ib)) {
- printf("Failed iconbox init...\n");
+ printf("Failed calendar init...\n");
FREE(ib);
ib = NULL;
}
@@ -224,6 +234,11 @@
DRETURN_PTR(EWL_WIDGET(ib), DLEVEL_STABLE);
}
+/**
+ * @param ib: The calendar widget to initialize
+ * @return Returns NULL on failure, a new Ewl_IconBox on success
+ * @brief Init a new Ewl_Calendar to default values and callbacks, and set
date to today
+ */
int ewl_calendar_init(Ewl_Calendar* ib) {
Ewl_Widget *w;
Ewl_Widget *vbox;
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/lib/ewl_calendar.h,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -3 -r1.1 -r1.2
--- ewl_calendar.h 10 Jul 2005 08:18:05 -0000 1.1
+++ ewl_calendar.h 10 Jul 2005 08:26:37 -0000 1.2
@@ -6,7 +6,8 @@
/**
* @file ewl_calendar.h
* @defgroup Ewl_Calendar Calendar: The EWL Calendar Widget
- * @brief Defines the Ewl_Calendar class,
+ * @brief Defines the Ewl_Calendar class
+ * Defined the Ewl_Calendar class, allowing selection of a day in time
*
*/
-------------------------------------------------------
This SF.Net email is sponsored by the 'Do More With Dual!' webinar happening
July 14 at 8am PDT/11am EDT. We invite you to explore the latest in dual
core and dual graphics technology at this free one hour event hosted by HP,
AMD, and NVIDIA. To register visit http://www.hp.com/go/dualwebinar
_______________________________________________
enlightenment-cvs mailing list
enlightenment-cvs@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs
