[gtkmm] Add an empty line after @newin where it's missing
- From: Kjell Ahlstedt <kjellahl src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtkmm] Add an empty line after @newin where it's missing
- Date: Fri, 12 Dec 2014 10:15:33 +0000 (UTC)
commit 884b3bf667c4545894827dcfe1629f0813ecbd72
Author: Kjell Ahlstedt <kjell ahlstedt bredband net>
Date: Fri Dec 12 11:12:10 2014 +0100
Add an empty line after @newin where it's missing
* gdk/src/device.hg:
* gdk/src/display.hg:
* gdk/src/rectangle.hg:
* gdk/src/screen.hg:
* gdk/src/window.hg:
* gtk/src/application.hg:
* gtk/src/builder.hg:
* gtk/src/entrybuffer.hg:
* gtk/src/iconview.hg:
* gtk/src/listbox.hg:
* gtk/src/listboxrow.hg:
* gtk/src/pagesetup.hg:
* gtk/src/papersize.hg:
* gtk/src/printsettings.hg:
* gtk/src/radiotoolbutton.hg:
* gtk/src/toolitem.hg:
* gtk/src/uimanager.hg:
* gtk/src/widget.hg: Add an empty line after @newin where it's needed in
order to avoid bad side effects in the documentation. Doxygen assumes that
@newin is followed by a paragraph that describes what is new.
gdk/src/device.hg | 2 ++
gdk/src/display.hg | 1 +
gdk/src/rectangle.hg | 4 ++++
gdk/src/screen.hg | 1 +
gdk/src/window.hg | 1 +
gtk/src/application.hg | 1 +
gtk/src/builder.hg | 3 +++
gtk/src/entrybuffer.hg | 2 +-
gtk/src/iconview.hg | 1 +
gtk/src/listbox.hg | 1 +
gtk/src/listboxrow.hg | 3 +++
gtk/src/pagesetup.hg | 1 +
gtk/src/papersize.hg | 1 +
gtk/src/printsettings.hg | 1 +
gtk/src/radiotoolbutton.hg | 1 +
gtk/src/toolitem.hg | 3 ++-
gtk/src/uimanager.hg | 1 +
gtk/src/widget.hg | 4 ++++
18 files changed, 30 insertions(+), 2 deletions(-)
---
diff --git a/gdk/src/device.hg b/gdk/src/device.hg
index 5ef2fc6..997ce76 100644
--- a/gdk/src/device.hg
+++ b/gdk/src/device.hg
@@ -178,6 +178,7 @@ public:
* unless there is an ongoing grab on them. See grab().
*
* @newin{3,0}
+ *
* @return The Gdk::Window under the device position.
*/
Glib::RefPtr<Window> get_window_at_position();
@@ -190,6 +191,7 @@ public:
* unless there is an ongoing grab on them. See grab().
*
* @newin{3,0}
+ *
* @return The Gdk::Window under the device position.
*/
Glib::RefPtr<const Window> get_window_at_position() const;
diff --git a/gdk/src/display.hg b/gdk/src/display.hg
index 50538e8..1007ca1 100644
--- a/gdk/src/display.hg
+++ b/gdk/src/display.hg
@@ -104,6 +104,7 @@ public:
/** Send a response to SelectionRequest event.
*
* @newin{2,2}
+ *
* @param requestor Window to which to deliver response.
* @param selection Selection that was requested.
* @param target Target that was selected.
diff --git a/gdk/src/rectangle.hg b/gdk/src/rectangle.hg
index 24b87c6..06772c3 100644
--- a/gdk/src/rectangle.hg
+++ b/gdk/src/rectangle.hg
@@ -79,6 +79,7 @@ public:
/** Checks whether two rectangles intersect.
*
* @newin{3,8}
+ *
* @param src2 The rectangle with which to check intersection with this rectangle.
* @result Whether this rectangle intersects @a src2.
*/
@@ -104,6 +105,7 @@ public:
* includes both @a src1 and @a src2 within it.
*
* @newin{3,8}
+ *
* @param src1 One of the rectangles.
* @param src2 The other rectangle.
* @returns The union of @a src1 and @a src2.
@@ -117,6 +119,7 @@ Rectangle join(const Rectangle& src1, const Rectangle& src2);
* are set to 0 and its x and y values are undefined.
*
* @newin{3,8}
+ *
* @param src1 One of the rectangles.
* @param src2 The other rectangle.
* @returns The intersection of @a src1 and @a src2.
@@ -130,6 +133,7 @@ Rectangle intersect(const Rectangle& src1, const Rectangle& src2);
* are set to 0 and its x and y values are undefined.
*
* @newin{3,8}
+ *
* @param src1 One of the rectangles.
* @param src2 The other rectangle.
* @param[out] rectangles_intersect This will be set to <tt>true</tt>
diff --git a/gdk/src/screen.hg b/gdk/src/screen.hg
index 3a7af2d..ad55338 100644
--- a/gdk/src/screen.hg
+++ b/gdk/src/screen.hg
@@ -85,6 +85,7 @@ public:
* @a screen, use get_n_monitors().
*
* @newin{3,6}
+ *
* @param monitor_num The monitor number.
* @result The monitor workarea.
*/
diff --git a/gdk/src/window.hg b/gdk/src/window.hg
index e68626b..3774b36 100644
--- a/gdk/src/window.hg
+++ b/gdk/src/window.hg
@@ -269,6 +269,7 @@ public:
/** Finds out the DND protocol supported by a window.
*
* @newin{3,0}
+ *
* @return The supported DND protocol.
*/
DragProtocol get_drag_protocol() const;
diff --git a/gtk/src/application.hg b/gtk/src/application.hg
index 6f2849f..6d219c2 100644
--- a/gtk/src/application.hg
+++ b/gtk/src/application.hg
@@ -232,6 +232,7 @@ public:
* from the application, the application's destructor will not be called.
*
* @newin{3,4}
+ *
* @param window A toplevel window to add to the application.
*/
void add_window(Window& window);
diff --git a/gtk/src/builder.hg b/gtk/src/builder.hg
index 5811378..06a1954 100644
--- a/gtk/src/builder.hg
+++ b/gtk/src/builder.hg
@@ -414,6 +414,7 @@ public:
* other object built by builder.
*
* @newin{3,12}
+ *
* @param name The name of the widget exposed to the builder.
* @param widget The widget to expose.
*/
@@ -425,6 +426,7 @@ public:
/** Gets the object named @a name.
*
* @newin{2,12}
+ *
* @param name Name of object to get.
* @return The object named @a name or <tt>0</tt> if it could not be found in the object tree.
*/
@@ -432,6 +434,7 @@ public:
/** Gets the object named @a name.
*
* @newin{3,8}
+ *
* @param name Name of object to get.
* @return The object named @a name or <tt>0</tt> if it could not be found in the object tree.
*/
diff --git a/gtk/src/entrybuffer.hg b/gtk/src/entrybuffer.hg
index b8b546d..907efb3 100644
--- a/gtk/src/entrybuffer.hg
+++ b/gtk/src/entrybuffer.hg
@@ -42,7 +42,7 @@ namespace Gtk
* useful in the case of important passwords. Or a derived class could
* integrate with an application's concept of undo/redo.
*
- * @@newin{2,20}
+ * @newin{2,20}
*/
class EntryBuffer : public Glib::Object
{
diff --git a/gtk/src/iconview.hg b/gtk/src/iconview.hg
index 59a4fd5..d15e388 100644
--- a/gtk/src/iconview.hg
+++ b/gtk/src/iconview.hg
@@ -344,6 +344,7 @@ public:
* the item pointed to by @a path. See also Tooltip::set_tip_area().
*
* @newin{2,12}
+ *
* @param tooltip A Gtk::Tooltip.
* @param path A Gtk::TreePath.
*/
diff --git a/gtk/src/listbox.hg b/gtk/src/listbox.hg
index 3f94094..ada6077 100644
--- a/gtk/src/listbox.hg
+++ b/gtk/src/listbox.hg
@@ -103,6 +103,7 @@ public:
* same effect of Gtk::Container::add().
*
* @newin{3,10}
+ *
* @param child The Gtk::Widget to add.
*/
void append(Widget& child);
diff --git a/gtk/src/listboxrow.hg b/gtk/src/listboxrow.hg
index c34aaea..d745660 100644
--- a/gtk/src/listboxrow.hg
+++ b/gtk/src/listboxrow.hg
@@ -40,6 +40,7 @@ public:
* header in the row, and be shown in front of the row in the ListBox.
*
* @newin{3,10}
+ *
* @param header The header.
*/
_WRAP_METHOD(void set_header(Widget& header), gtk_list_box_row_set_header)
@@ -56,6 +57,7 @@ public:
* set already, and if so to update the state of it.
*
* @newin{3,10}
+ *
* @return The current header, or <tt>0</tt> if none.
*/
_WRAP_METHOD(Widget* get_header(), gtk_list_box_row_get_header)
@@ -65,6 +67,7 @@ public:
* set already, and if so to update the state of it.
*
* @newin{3,10}
+ *
* @return The current header, or <tt>0</tt> if none.
*/
_WRAP_METHOD(const Widget* get_header() const, gtk_list_box_row_get_header, constversion)
diff --git a/gtk/src/pagesetup.hg b/gtk/src/pagesetup.hg
index ded62d2..3da6d22 100644
--- a/gtk/src/pagesetup.hg
+++ b/gtk/src/pagesetup.hg
@@ -146,6 +146,7 @@ public:
* in the group "Page Setup"
*
* @newin{2,12}
+ *
* @param key_file The G::KeyFile to save the page setup to.
*/
void save_to_key_file(Glib::KeyFile& key_file) const;
diff --git a/gtk/src/papersize.hg b/gtk/src/papersize.hg
index c8e5e52..f4b0909 100644
--- a/gtk/src/papersize.hg
+++ b/gtk/src/papersize.hg
@@ -110,6 +110,7 @@ public:
/** This function adds the paper size to @a key_file in the first group.
*
* @newin{2,12}
+ *
* @param key_file The Glib::KeyFile to save the paper size to.
*/
void save_to_key_file(Glib::KeyFile& key_file);
diff --git a/gtk/src/printsettings.hg b/gtk/src/printsettings.hg
index 0344245..2f34b8d 100644
--- a/gtk/src/printsettings.hg
+++ b/gtk/src/printsettings.hg
@@ -166,6 +166,7 @@ public:
* in the "Print Settings" group.
*
* @newin{2,12}
+ *
* @param key_file The Glib::KeyFile to save the print settings to.
*/
void save_to_key_file(Glib::KeyFile& key_file) const;
diff --git a/gtk/src/radiotoolbutton.hg b/gtk/src/radiotoolbutton.hg
index 39b5454..77dcd94 100644
--- a/gtk/src/radiotoolbutton.hg
+++ b/gtk/src/radiotoolbutton.hg
@@ -105,6 +105,7 @@ public:
* You can obtain a suitable group from another radio tool button by using get_group().
*
* @newin{2,4}
+ *
* @param group An existing radio button group.
*/
void set_group(Group& group);
diff --git a/gtk/src/toolitem.hg b/gtk/src/toolitem.hg
index 0bf214f..78bbefc 100644
--- a/gtk/src/toolitem.hg
+++ b/gtk/src/toolitem.hg
@@ -93,8 +93,9 @@ public:
/** Removes the MenuItem used in the toolbar overflow menu, if any.
* The @a menu_item_id is used to identify the caller of this function and
* should also be used with get_proxy_menu_item().
- *
+ *
* @newin{3,12}
+ *
* @param menu_item_id A string used to identify the MenuItem.
*/
void unset_proxy_menu_item(const Glib::ustring& menu_item_id);
diff --git a/gtk/src/uimanager.hg b/gtk/src/uimanager.hg
index 7bb9efe..79dc29b 100644
--- a/gtk/src/uimanager.hg
+++ b/gtk/src/uimanager.hg
@@ -243,6 +243,7 @@ public:
* @see add_ui().
*
* @newin{2,4}
+ *
* @param merge_id The merge id for the merged UI, see gtk_ui_manager_new_merge_id().
* @param path A path.
* @param name The name for the added UI element.
diff --git a/gtk/src/widget.hg b/gtk/src/widget.hg
index 8361f98..85d38fe 100644
--- a/gtk/src/widget.hg
+++ b/gtk/src/widget.hg
@@ -414,6 +414,7 @@ public:
/** Undoes the effect of previous calls to override_color().
*
* @newin{3,0}
+ *
* @param state The state for which to use the color of the user's theme.
*/
void unset_color(StateFlags state = STATE_FLAG_NORMAL);
@@ -423,6 +424,7 @@ public:
/** Undoes the effect of previous calls to override_background_color().
*
* @newin{3,0}
+ *
* @param state The state for which to use the background color of the user's theme.
*/
void unset_background_color(StateFlags state = STATE_FLAG_NORMAL);
@@ -440,6 +442,7 @@ public:
/** Undoes the effect of previous calls to override_symbolic_color().
*
* @newin{3,0}
+ *
* @param name The name of the symbolic color to fetch from the user's theme.
*/
void unset_symbolic_color(const Glib::ustring& name);
@@ -856,6 +859,7 @@ protected:
* and they should call it in their on_realize() function.
*
* @newin{2,18}
+ *
* @param window A Gdk::Window.
*/
void set_window(const Glib::RefPtr<Gdk::Window>& window);
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]