Enlightenment CVS committal
Author : dj2
Project : e17
Module : libs/ewl
Dir : e17/libs/ewl/src/lib
Modified Files:
ewl_border.c ewl_grid.c ewl_misc.c ewl_notebook.c ewl_row.c
ewl_selectionbar.c ewl_selectionbook.c ewl_tooltip.c
Log Message:
- documentation fixes
- remove some commeted code
- fixup some // comments to /* */
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/lib/ewl_border.c,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -3 -r1.1 -r1.2
--- ewl_border.c 9 Feb 2005 04:31:54 -0000 1.1
+++ ewl_border.c 16 Feb 2005 04:23:40 -0000 1.2
@@ -79,7 +79,7 @@
}
/**
- * @param e: the border to retrieve the label text
+ * @param b: the border to retrieve the label text
* @return Returns the border label text on success, NULL on failure.
* @brief Get the text label from a border widget
*/
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/lib/ewl_grid.c,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -3 -r1.1 -r1.2
--- ewl_grid.c 9 Feb 2005 04:31:55 -0000 1.1
+++ ewl_grid.c 16 Feb 2005 04:23:41 -0000 1.2
@@ -4,10 +4,10 @@
/**
* ewl_grid_new - create a new grid
- * @cols: number of columns
- * @rows: number of rows
+ * @param cols: number of columns
+ * @param rows: number of rows
*
- * Returns a pointer to a newly allocated grid on success, NULL on
+ * @return Returns a pointer to a newly allocated grid on success, NULL on
* failure.
*/
Ewl_Widget *ewl_grid_new(int cols, int rows)
@@ -28,11 +28,11 @@
/**
* ewl_grid_init - initialize the grid to starting values
- * @g: the grid
- * @cols: number of columns
- * @rows: number of rows
+ * @param g: the grid
+ * @param cols: number of columns
+ * @param rows: number of rows
*
- * Returns no value. Responsible for setting up default values and
+ * @return Returns no value. Responsible for setting up default values and
* callbacks within a grid structure
*/
int ewl_grid_init(Ewl_Grid * g, int cols, int rows)
@@ -86,11 +86,11 @@
/**
* ewl_grid_reset - clear the grid and set new geometry
- * @g: the grid
- * @cols: the new number of columns
- * @rows: the new number of rows
+ * @param g: the grid
+ * @param cols: the new number of columns
+ * @param rows: the new number of rows
*
- * Returns no value
+ * @return Returns no value
*/
void ewl_grid_reset(Ewl_Grid * g, int cols, int rows)
{
@@ -123,16 +123,16 @@
g->rows = rows;
- // store the total size of the grid widget /
+ /* store the total size of the grid widget */
g->grid_w = CURRENT_W(EWL_OBJECT(w));
g->grid_h = CURRENT_H(EWL_OBJECT(w));
- // initialize the column width to default values /
+ /* initialize the column width to default values */
for (i = 0; i < g->cols; i++)
g->col_size[i].size = CURRENT_W(g) / g->cols;
- // initialize the row height to default values /
+ /* initialize the row height to default values */
for (i = 0; i < g->rows; i++)
g->row_size[i].size = CURRENT_H(g) / g->rows;
@@ -145,14 +145,14 @@
/**
* ewl_grid_add - add a child widget to the grid
- * @g: the grid
- * @w: the child widget
- * @start_col: the start column
- * @end_col: the end column
- * @start_row: the start row
- * @end_row: the end row
+ * @param g: the grid
+ * @param w: the child widget
+ * @param start_col: the start column
+ * @param end_col: the end column
+ * @param start_row: the start row
+ * @param end_row: the end row
*
- * Returns no value
+ * @return Returns no value
*/
void
ewl_grid_add(Ewl_Grid * g, Ewl_Widget * w,
@@ -206,11 +206,11 @@
/**
* ewl_grid_col_w_set - set the width of a column
- * @g: the grid
- * @col: the column
- * @width: the new width
+ * @param g: the grid
+ * @param col: the column
+ * @param width: the new width
*
- * Returns no value.
+ * @return Returns no value.
*/
void ewl_grid_col_w_set(Ewl_Grid * g, int col, int width)
{
@@ -245,11 +245,11 @@
/**
* ewl_grid_col_w_get - get the width of a column
*
- * @g: the grid
- * @col: the column
- * @width: integer pointer to store the width in
+ * @param g: the grid
+ * @param col: the column
+ * @param width: integer pointer to store the width in
*
- * Returns no value.
+ * @return Returns no value.
*/
void ewl_grid_col_w_get(Ewl_Grid * g, int col, int *width)
{
@@ -264,11 +264,11 @@
/**
* ewl_grid_row_h_set - set the height of a row
- * @g: the grid
- * @col: the row
- * @width: the new height
+ * @param g: the grid
+ * @param row: the row
+ * @param height: the new height
*
- * Returns no value.
+ * @return Returns no value.
*/
void ewl_grid_row_h_set(Ewl_Grid * g, int row, int height)
{
@@ -300,11 +300,11 @@
/**
* ewl_grid_row_h_get - get the height of a row
*
- * @g: the grid
- * @row: the row
- * @height: integer pointer to store the height in
+ * @param g: the grid
+ * @param row: the row
+ * @param height: integer pointer to store the height in
*
- * Returns no value.
+ * @return Returns no value.
*/
void ewl_grid_row_h_get(Ewl_Grid * g, int row, int *height)
{
@@ -329,16 +329,16 @@
ewl_widget_show(w);
- // store the total size of the grid widget /
+ /* store the total size of the grid widget */
g->grid_w = CURRENT_W(EWL_OBJECT(w));
g->grid_h = CURRENT_H(EWL_OBJECT(w));
- // initialize the column width to default values /
+ /* initialize the column width to default values */
for (i = 0; i < g->cols; i++)
g->col_size[i].size = g->grid_w / g->cols;
- // initialize the row height to default values /
+ /* initialize the row height to default values */
for (i = 0; i < g->rows; i++)
g->row_size[i].size = g->grid_h / g->rows;
@@ -445,8 +445,6 @@
if (w_flag) {
for (i = 0; i < g->cols; i++) {
g->col_size[i].size += ((new_w - g->grid_w) / g->cols);
-
-/* printf("col: %d, width: %d\n", i, g->col_size[i].size);
*/
}
g->grid_w = new_w;
}
@@ -458,8 +456,6 @@
if (h_flag) {
for (i = 0; i < g->rows; i++) {
g->row_size[i].size += ((new_h - g->grid_h) / g->rows);
-
-/* printf("a row: %d, height: %d\n", i,
g->row_size[i].size); */
}
g->grid_h = new_h;
}
@@ -690,3 +686,4 @@
DLEAVE_FUNCTION(DLEVEL_STABLE);
}
+
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/lib/ewl_misc.c,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -3 -r1.1 -r1.2
--- ewl_misc.c 9 Feb 2005 04:31:55 -0000 1.1
+++ ewl_misc.c 16 Feb 2005 04:23:41 -0000 1.2
@@ -404,7 +404,7 @@
* @return Returns no value.
* @brief Ask for a widget to be configured during idle loop
*
- * Ask for the widget @w to be configured when the main idle loop is executed.
+ * Ask for the widget @a w to be configured when the main idle loop is
executed.
*/
void ewl_configure_request(Ewl_Widget * w)
{
@@ -610,7 +610,7 @@
* @return Returns no value.
* @brief Cancel a request to configure a widget
*
- * Remove the widget @w from the list of widgets that need to be configured.
+ * Remove the widget @a w from the list of widgets that need to be configured.
*/
void ewl_configure_cancel_request(Ewl_Widget *w)
{
@@ -654,7 +654,7 @@
* @return Returns no value.
* @brief Cancel a request to realize a widget
*
- * Remove the widget @w from the list of widgets that need to be realized.
+ * Remove the widget @a w from the list of widgets that need to be realized.
*/
void ewl_realize_cancel_request(Ewl_Widget *w)
{
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/lib/ewl_notebook.c,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -3 -r1.1 -r1.2
--- ewl_notebook.c 9 Feb 2005 04:31:55 -0000 1.1
+++ ewl_notebook.c 16 Feb 2005 04:23:41 -0000 1.2
@@ -97,12 +97,11 @@
/**
* ewl_notebook_page_append - append a page to the notebook
- * @n: the notebook to append the page
- * @t: the tab of the new page added
- b
- * @p: the contents of the page added
+ * @param n: the notebook to append the page
+ * @param t: the tab of the new page added
+ * @param p: the contents of the page added
*
- * Returns no value. Appends a page to the list of available pages that will
+ * @return Returns no value. Appends a page to the list of available pages
that will
* be available for display.
*/
void
@@ -118,11 +117,11 @@
/**
* ewl_notebook_page_prepend - prepend a page to the notebook
- * @n: the notebook to prepend the page
- * @t: the tab of the new page added
- * @p: the contents of the page added
+ * @param n: the notebook to prepend the page
+ * @param t: the tab of the new page added
+ * @param p: the contents of the page added
*
- * Returns no value. Prepends a page to the list of available pages that will
+ * @return Returns no value. Prepends a page to the list of available pages
that will
* be available for display.
*/
void
@@ -137,12 +136,12 @@
/**
* ewl_notebook_page_insert - insert a page to the notebook
- * @n: the notebook to insert the page
- * @t: the tab of the new page added
- * @p: the contents of the page added
- * @pos: the position in the list of tabs to add the page
+ * @param n: the notebook to insert the page
+ * @param t: the tab of the new page added
+ * @param p: the contents of the page added
+ * @param pos: the position in the list of tabs to add the page
*
- * Returns no value. Insert a page to the list of available pages that will
+ * @return Returns no value. Insert a page to the list of available pages that
will
* be available for display.
*/
void
@@ -197,9 +196,9 @@
/**
* ewl_notebook_first_page_remove - remove the first page from the notebook
- * @n: the notebook to remove the first page
+ * @param n: the notebook to remove the first page
*
- * Returns a pointer to the removed page on success, NULL on failure.
+ * @return Returns a pointer to the removed page on success, NULL on failure.
*/
void
ewl_notebook_first_page_remove(Ewl_Notebook * n)
@@ -213,9 +212,9 @@
/**
* ewl_notebook_first_page_remove - remove the last page from the notebook
- * @n: the notebook to remove the last page
+ * @param n: the notebook to remove the last page
*
- * Returns a pointer to the removed page on success, NULL on failure.
+ * @return Returns a pointer to the removed page on success, NULL on failure.
*/
void
ewl_notebook_last_page_remove(Ewl_Notebook * n)
@@ -229,10 +228,10 @@
/**
* ewl_notebook_page_remove - remove the specified page from the notebook
- * @n: the notebook to remove the specified page
- * @i: the position in the list of pages to remove from @n
+ * @param n: the notebook to remove the specified page
+ * @param i: the position in the list of pages to remove from @n
*
- * Returns a pointer to the removed page on success, NULL on failure.
+ * @return Returns a pointer to the removed page on success, NULL on failure.
*/
void
ewl_notebook_page_remove(Ewl_Notebook * n, int i)
@@ -273,9 +272,9 @@
/**
* ewl_notebook_visible_page_remove - remove the visible page from the notebook
- * @n: the notebook to remove the visible page
+ * @param n: the notebook to remove the visible page
*
- * Returns no value.
+ * @return Returns no value.
*/
void
ewl_notebook_visible_page_remove(Ewl_Notebook * n)
@@ -300,10 +299,10 @@
/**
* ewl_notebook_tabs_alignment_set - set the alignment of a notebooks tabs
- * @n: the notebook to change tab alignment
- * @a: the new alignment for the tabs of @n
+ * @param n: the notebook to change tab alignment
+ * @param a: the new alignment for the tabs of @a n
*
- * Returns no value. Changes the alignment of the tabs on @n to @a, and
+ * @return Returns no value. Changes the alignment of the tabs on @a n to @a
a, and
* updates the display.
*/
void
@@ -318,9 +317,9 @@
/**
* ewl_notebook_tabs_alignment_get - get the alignment of a notebooks tabs
- * @n: the notebook to get tab alignment
+ * @param n: the notebook to get tab alignment
*
- * Returns the tab alignment of the notebook @n on success, 0 on failure.
+ * @return Returns the tab alignment of the notebook @n on success, 0 on
failure.
*/
unsigned int
ewl_notebook_tabs_alignment_get(Ewl_Notebook * n)
@@ -337,10 +336,10 @@
/**
* ewl_notebook_tabs_position_set - set a notebooks tab position
- * @n: the notebook to change tab position
- * @p: the new position for the tabs of @n
+ * @param n: the notebook to change tab position
+ * @param p: the new position for the tabs of @n
*
- * Returns no value. Changes the tab position of @n to @p and updates the
+ * @return Returns no value. Changes the tab position of @n to @p and updates
the
* display.
*/
void
@@ -398,9 +397,9 @@
/**
* ewl_notebook_tabs_position_get - get the position of a notebooks tabs
- * @n: the notebook to retrieve the tab position
+ * @param n: the notebook to retrieve the tab position
*
- * Returns the position of the tabs in @n on success, 0 on failure.
+ * @return Returns the position of the tabs in @n on success, 0 on failure.
*/
Ewl_Position
ewl_notebook_tabs_position_get(Ewl_Notebook * n)
@@ -413,10 +412,10 @@
/**
* ewl_notebook_tabs_visible_set - set the visibility of the tabs
- * @n: the notebook to change flags
- * @show: the sets if the tabs should be shown (0) or not (1)
+ * @param n: the notebook to change flags
+ * @param show: the sets if the tabs should be shown (0) or not (1)
*
- * Returns no value. Sets the visiblity for the tabs
+ * @return Returns no value. Sets the visiblity for the tabs
*/
void
ewl_notebook_tabs_visible_set(Ewl_Notebook * n, int show)
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/lib/ewl_row.c,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -3 -r1.1 -r1.2
--- ewl_row.c 9 Feb 2005 04:31:55 -0000 1.1
+++ ewl_row.c 16 Feb 2005 04:23:41 -0000 1.2
@@ -27,7 +27,7 @@
* @return Returns TRUE on success, FALSE on failure.
* @brief Initialize the row fields of an inheriting object
*
- * The fields of the @row object are initialized to their defaults.
+ * The fields of the @a row object are initialized to their defaults.
*/
int ewl_row_init(Ewl_Row *row)
{
@@ -100,7 +100,7 @@
/**
* @param row: the row to retrieve a columns widget from
* @param n: the column containing the desired widget
- * @return Returns widget located in column @n in @row on success.
+ * @return Returns widget located in column @a n in @a row on success.
* @brief Retrieve the widget at a specified column
*/
Ewl_Widget *
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/lib/ewl_selectionbar.c,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -3 -r1.1 -r1.2
--- ewl_selectionbar.c 9 Feb 2005 04:31:55 -0000 1.1
+++ ewl_selectionbar.c 16 Feb 2005 04:23:41 -0000 1.2
@@ -32,7 +32,8 @@
/**
* ewl_selectionbar_init - initialize a new selectionbar
- * @s: the selectionbar to initialize
+ * @param s: the selectionbar to initialize
+ * @param parent: the parent widget
*
* Returns no value. Sets up the default callbacks and values for the
* the selectionbar
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/lib/ewl_selectionbook.c,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -3 -r1.1 -r1.2
--- ewl_selectionbook.c 9 Feb 2005 04:31:55 -0000 1.1
+++ ewl_selectionbook.c 16 Feb 2005 04:23:41 -0000 1.2
@@ -5,7 +5,6 @@
/**
* ewl_selectionbook_new - create a new selectionbook
- * @window: the window the book will be added to
*
* Returns a newly allocated selectionbook on success, NULL on failure.
*/
@@ -27,11 +26,10 @@
/**
* ewl_selectionbook_init - initialize a selectionbook widget
- * @s: the selectionbook widget
- * @window: the window the book will be added to
+ * @param s: the selectionbook widget
*
* Returns no value. Sets the fields and callbacks of the selectionbook
- * @s to their default values.
+ * @a s to their default values.
*/
void ewl_selectionbook_init(Ewl_Selectionbook * s)
{
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/lib/ewl_tooltip.c,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -3 -r1.1 -r1.2
--- ewl_tooltip.c 9 Feb 2005 04:31:55 -0000 1.1
+++ ewl_tooltip.c 16 Feb 2005 04:23:41 -0000 1.2
@@ -2,7 +2,7 @@
/**
- * @parent: the widget this tooltip relates
+ * @param parent: the widget this tooltip relates
* @return Returns a new tooltip widget on success, NULL on failure.
* @brief Creates a new tooltip widget for a specific parent.
*/
@@ -24,8 +24,8 @@
}
/**
- * @t: the tooltip widget to initialize to default values
- * @parent: the parent widget the tooltip is associated with
+ * @param t: the tooltip widget to initialize to default values
+ * @param parent: the parent widget the tooltip is associated with
* @return Returns TRUE on success, FALSE otherwise.
* @brief Initialize the default values of the tooltip fields.
*/
-------------------------------------------------------
SF email is sponsored by - The IT Product Guide
Read honest & candid reviews on hundreds of IT Products from real users.
Discover which products truly live up to the hype. Start reading now.
http://ads.osdn.com/?ad_id=6595&alloc_id=14396&op=click
_______________________________________________
enlightenment-cvs mailing list
enlightenment-cvs@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs
