Enlightenment CVS committal
Author : dj2
Project : e17
Module : libs/ewl
Dir : e17/libs/ewl/src/lib
Modified Files:
ewl_box.h ewl_button.c ewl_button.h ewl_calendar.c
ewl_calendar.h ewl_callback.h ewl_cell.h ewl_check.h
Log Message:
- documentation fixes
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/lib/ewl_box.h,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -3 -r1.8 -r1.9
--- ewl_box.h 12 Jan 2006 18:21:18 -0000 1.8
+++ ewl_box.h 15 Feb 2006 17:40:49 -0000 1.9
@@ -1,9 +1,8 @@
-#ifndef __EWL_BOX_H__
-#define __EWL_BOX_H__
+#ifndef EWL_BOX_H
+#define EWL_BOX_H
/**
- * @file ewl_box.h
- * @defgroup Ewl_Box Box: The Box Layout Container.
+ * @defgroup Ewl_Box Ewl_Box: The Box Layout Container.
* @brief Defines the Ewl_Box class used for laying out Ewl_Widget's in a
* horizontal or vertical line.
*
@@ -77,4 +76,4 @@
* @}
*/
-#endif /* __EWL_BOX_H__ */
+#endif
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/lib/ewl_button.c,v
retrieving revision 1.25
retrieving revision 1.26
diff -u -3 -r1.25 -r1.26
--- ewl_button.c 6 Feb 2006 16:32:10 -0000 1.25
+++ ewl_button.c 15 Feb 2006 17:40:49 -0000 1.26
@@ -155,6 +155,7 @@
* @param b: The button to set the stock type on
* @param stock: The Ewl_Stock_Type to set on the button
* @return Returns no value.
+ * @brief Set the type of the stock button to use
*/
void
ewl_button_stock_type_set(Ewl_Button *b, Ewl_Stock_Type stock)
@@ -195,6 +196,7 @@
/**
* @param b: The button to get the stock type from
* @return Returns the Ewl_Stock_Type of the button
+ * @brief Get the stock button type in use
*/
Ewl_Stock_Type
ewl_button_stock_type_get(Ewl_Button *b)
@@ -211,6 +213,7 @@
* @param file: The file to use for the image
* @param key: The edje key to use for the image (or NULL if not using edje)
* @return Returns no value.
+ * @brief Set the image file @p file and the image key @p key to use
*/
void
ewl_button_image_set(Ewl_Button *b, const char *file, const char *key)
@@ -235,6 +238,7 @@
/**
* @param b: The button to the the image file from
* @return Returns the image file used in the button or NULL on failure
+ * @brief Get the image file used by the button
*/
const char *
ewl_button_image_get(Ewl_Button *b)
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/lib/ewl_button.h,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -3 -r1.9 -r1.10
--- ewl_button.h 12 Jan 2006 18:21:18 -0000 1.9
+++ ewl_button.h 15 Feb 2006 17:40:49 -0000 1.10
@@ -1,9 +1,8 @@
-#ifndef __EWL_BUTTON_H__
-#define __EWL_BUTTON_H__
+#ifndef EWL_BUTTON_H
+#define EWL_BUTTON_H
/**
- * @file ewl_button.h
- * @defgroup Ewl_Button Button: The Basic Button
+ * @defgroup Ewl_Button Ewl_Button: The Basic Button
* @brief The button class is a basic button with a label. This class inherits
* from the Ewl_Box to allow for placing any other widget inside the button.
*
@@ -38,7 +37,7 @@
struct Ewl_Button
{
Ewl_Box box; /**< Inherit from the box for adding
widgets */
- Ewl_Widget *body;
+ Ewl_Widget *body; /**< The body of the button */
Ewl_Widget *label_object; /**< Labels are common, make it easy */
Ewl_Widget *image_object; /**< Add an image to the button if
needed */
Ewl_Stock_Type stock_type; /**< The stock type of the button */
@@ -64,5 +63,5 @@
* @}
*/
-#endif /* __EWL_BUTTON_H__ */
+#endif
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/lib/ewl_calendar.c,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -3 -r1.14 -r1.15
--- ewl_calendar.c 12 Jan 2006 18:21:18 -0000 1.14
+++ ewl_calendar.c 15 Feb 2006 17:40:49 -0000 1.15
@@ -156,6 +156,7 @@
/**
* @param c: The Ewl_Calendar to get the day from
* @return Returns the day currently selected in the calendar
+ * @brief Returns the current day selected in the calendar
*/
int
ewl_calendar_day_get(Ewl_Calendar *c)
@@ -170,6 +171,7 @@
/**
* @param c: The Ewl_Calendar to get the month from
* @return Returns the month currently selected in the calendar
+ * @brief Returns the month selected in the calendar
*/
int
ewl_calendar_month_get(Ewl_Calendar *c)
@@ -184,6 +186,7 @@
/**
* @param c: The Ewl_Calendar to get the year from
* @return Returns the current year selected in the calendar
+ * @brief Returns the year currently selected in the calendar
*/
int
ewl_calendar_year_get(Ewl_Calendar *c)
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/lib/ewl_calendar.h,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -3 -r1.7 -r1.8
--- ewl_calendar.h 12 Jan 2006 18:21:18 -0000 1.7
+++ ewl_calendar.h 15 Feb 2006 17:40:49 -0000 1.8
@@ -1,12 +1,11 @@
-#ifndef __EWL_CALENDAR_H__
-#define __EWL_CALENDAR_H__
+#ifndef EWL_CALENDAR_H
+#define EWL_CALENDAR_H
/**
- * @file ewl_calendar.h
- * @defgroup Ewl_Calendar Calendar: The EWL Calendar Widget
+ * @defgroup Ewl_Calendar Ewl_Calendar: The EWL Calendar Widget
* @brief Defines the Ewl_Calendar class
- * Defined the Ewl_Calendar class, allowing selection of a day in time
*
+ * @{
*/
/**
@@ -16,6 +15,9 @@
#define EWL_CALENDAR_TYPE "calendar"
+/**
+ * The Ewl_Calendar structure
+ */
typedef struct Ewl_Calendar Ewl_Calendar;
/**
@@ -31,21 +33,25 @@
*/
struct Ewl_Calendar
{
- Ewl_Box box; /**< Inherit from Ewl_Box */
+ Ewl_Box box; /**< Inherit from Ewl_Box */
- int cur_day;
- int cur_month;
- int cur_year;
- Ewl_Widget *grid;
- Ewl_Widget *month_label;
+ int cur_day; /**< The current day selected */
+ int cur_month; /**< The current month selected */
+ int cur_year; /**< The current year selected */
+ Ewl_Widget *grid; /**< The layout grid */
+ Ewl_Widget *month_label; /**< The month label */
};
Ewl_Widget *ewl_calendar_new(void);
int ewl_calendar_init(Ewl_Calendar *calendar);
-char * ewl_calendar_ascii_time_get(Ewl_Calendar *cal);
+char *ewl_calendar_ascii_time_get(Ewl_Calendar *cal);
int ewl_calendar_day_get(Ewl_Calendar *c);
int ewl_calendar_month_get(Ewl_Calendar *c);
int ewl_calendar_year_get(Ewl_Calendar *c);
+/**
+ * @}
+ */
+
#endif
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/lib/ewl_callback.h,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -3 -r1.7 -r1.8
--- ewl_callback.h 31 Jan 2006 16:37:09 -0000 1.7
+++ ewl_callback.h 15 Feb 2006 17:40:49 -0000 1.8
@@ -1,9 +1,8 @@
-#ifndef __EWL_CALLBACK_H__
-#define __EWL_CALLBACK_H__
+#ifndef EWL_CALLBACK_H
+#define EWL_CALLBACK_H
/**
- * @file ewl_callback.h
- * @defgroup Ewl_Callback Callback: The Callback Mechanisms
+ * @defgroup Ewl_Callback Ewl_Callback: The Callback Mechanisms
* Defines methods for creating and modifying callbacks on widgets
*
* @{
@@ -26,7 +25,6 @@
typedef void (*Ewl_Callback_Function) (Ewl_Widget * widget, void *ev_data,
void *user_data);
-
/**
* @def EWL_CALLBACK_FUNCTION(cb_func)
* Typecasts a pointer to an Ewl_Callback_Function pointer.
@@ -143,4 +141,4 @@
* @}
*/
-#endif /* __EWL_CALLBACK_H__ */
+#endif
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/lib/ewl_cell.h,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -3 -r1.4 -r1.5
--- ewl_cell.h 12 Jan 2006 18:21:18 -0000 1.4
+++ ewl_cell.h 15 Feb 2006 17:40:49 -0000 1.5
@@ -1,11 +1,9 @@
-#ifndef _EWL_CELL_H
-#define _EWL_CELL_H
+#ifndef EWL_CELL_H
+#define EWL_CELL_H
/**
- * @file ewl_cell.h
- * @defgroup Ewl_Cell Cell: The Cell Container, Layout for a Single Widget
- * Defines a container to layout a single child with all of it's available
- * space.
+ * @defgroup Ewl_Cell Ewl_Cell: The Cell Container, Layout for a Single Widget
+ * Defines a container to layout a single child with all of it's available
space.
*
* @{
*/
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/lib/ewl_check.h,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -3 -r1.6 -r1.7
--- ewl_check.h 12 Jan 2006 18:21:18 -0000 1.6
+++ ewl_check.h 15 Feb 2006 17:40:49 -0000 1.7
@@ -1,10 +1,8 @@
-#ifndef _EWL_CHECK_H_
-#define _EWL_CHECK_H_
+#ifndef EWL_CHECK_H
+#define EWL_CHECK_H
/**
- * @file ewl_check.h
- *
- * @defgroup Ewl_Check Check: The Simple Check for a Checkbutton
+ * @defgroup Ewl_Check Ewl_Check: The Simple Check for a Checkbutton
* Defines a widget with single purpose of providing a button with a checked
* state, without any extra decorating.
*
@@ -37,8 +35,8 @@
*/
struct Ewl_Check
{
- Ewl_Widget w; /**< Inherit from Ewl_Widget */
- int checked; /**< Indicates if this is checked */
+ Ewl_Widget w; /**< Inherit from Ewl_Widget */
+ int checked; /**< Indicates if this is checked */
};
Ewl_Widget *ewl_check_new(void);
-------------------------------------------------------
This SF.net email is sponsored by: Splunk Inc. Do you grep through log files
for problems? Stop! Download the new AJAX search engine that makes
searching your log files as easy as surfing the web. DOWNLOAD SPLUNK!
http://sel.as-us.falkag.net/sel?cmd=lnk&kid=103432&bid=230486&dat=121642
_______________________________________________
enlightenment-cvs mailing list
enlightenment-cvs@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs
