[glibmm] Add an empty line after @newin where it's missing
- From: Kjell Ahlstedt <kjellahl src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glibmm] Add an empty line after @newin where it's missing
- Date: Thu, 11 Dec 2014 17:26:33 +0000 (UTC)
commit ad432aca41acc47e00bb137ac1b55a03a59ba05d
Author: Kjell Ahlstedt <kjell ahlstedt bredband net>
Date: Thu Dec 11 18:20:33 2014 +0100
Add an empty line after @newin where it's missing
* gio/src/action.hg:
* gio/src/cancellable.hg:
* gio/src/charsetconverter.hg:
* gio/src/mount.hg:
* gio/src/notification.hg:
* gio/src/simpleaction.hg:
* gio/src/socket.hg:
* glib/src/datetime.hg:
* glib/src/glib_docs_override.xml:
* glib/src/keyfile.hg:
* glib/src/variant.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.
gio/src/action.hg | 2 ++
gio/src/cancellable.hg | 3 +--
gio/src/charsetconverter.hg | 1 +
gio/src/mount.hg | 3 +--
gio/src/notification.hg | 2 ++
gio/src/simpleaction.hg | 4 ++++
gio/src/socket.hg | 3 +--
glib/src/datetime.hg | 3 +++
glib/src/glib_docs_override.xml | 1 +
glib/src/keyfile.hg | 1 +
glib/src/variant.hg | 1 +
11 files changed, 18 insertions(+), 6 deletions(-)
---
diff --git a/gio/src/action.hg b/gio/src/action.hg
index 932ab8c..5e6dcf8 100644
--- a/gio/src/action.hg
+++ b/gio/src/action.hg
@@ -119,6 +119,7 @@ public:
* See get_state_hint().
*
* @newin{2,38}
+ *
* @param value The new state.
*/
template <typename T_Value>
@@ -180,6 +181,7 @@ public:
* Detailed action names can have three formats. See parse_detailed_name_variant().
*
* @newin{2,40}
+ *
* @param detailed_name A detailed action name.
* @param[out] action_name The action name.
* @param[out] target_value The target value.
diff --git a/gio/src/cancellable.hg b/gio/src/cancellable.hg
index 2fcd58b..886dc27 100644
--- a/gio/src/cancellable.hg
+++ b/gio/src/cancellable.hg
@@ -1,5 +1,3 @@
-// -*- Mode: C++; indent-tabs-mode: nil; c-basic-offset: 2 -*-
-
/* Copyright (C) 2007 The gtkmm Development Team
*
* This library is free software; you can redistribute it and/or
@@ -75,6 +73,7 @@ public:
* See Cancellable::signal_cancelled() for details on how to use this.
*
* @newin{2,22}
+ *
* @param slot The slot to connect.
* @return The id of the signal handler or 0 if @a cancellable has already
* been cancelled.
diff --git a/gio/src/charsetconverter.hg b/gio/src/charsetconverter.hg
index b4808c8..d5f8d87 100644
--- a/gio/src/charsetconverter.hg
+++ b/gio/src/charsetconverter.hg
@@ -43,6 +43,7 @@ public:
/** Creates a new CharsetConverter.
*
* @newin{2,24}
+ *
* @param to_charset Destination charset.
* @param from_charset Source charset.
* @return A new CharsetConverter, or <tt>0</tt> on error.
diff --git a/gio/src/mount.hg b/gio/src/mount.hg
index 18c03b0..7ca1731 100644
--- a/gio/src/mount.hg
+++ b/gio/src/mount.hg
@@ -1,5 +1,3 @@
-// -*- Mode: C++; indent-tabs-mode: nil; c-basic-offset: 2 -*-
-
/* Copyright (C) 2007 The gtkmm Development Team
*
* This library is free software; you can redistribute it and/or
@@ -217,6 +215,7 @@ public:
* does not support content guessing.
*
* @newin{2,18}
+ *
* @param result An AsyncResult.
* @return An array of content types.
* @throw Glib::Error
diff --git a/gio/src/notification.hg b/gio/src/notification.hg
index b2a891f..caf5f94 100644
--- a/gio/src/notification.hg
+++ b/gio/src/notification.hg
@@ -76,6 +76,7 @@ public:
* @a action will be activated with @a target as its parameter.
*
* @newin{2,40}
+ *
* @param label Label of the button.
* @param action An action name.
* @param target @a action's parameter.
@@ -96,6 +97,7 @@ public:
* was sent on is activated.
*
* @newin{2,40}
+ *
* @param action An action name.
* @param target @a action's parameter.
*/
diff --git a/gio/src/simpleaction.hg b/gio/src/simpleaction.hg
index 4765674..4b5b91e 100644
--- a/gio/src/simpleaction.hg
+++ b/gio/src/simpleaction.hg
@@ -88,6 +88,7 @@ public:
* must have the same VariantType as the initial state.
*
* @newin{2,38}
+ *
* @param name The name of the action.
* @param state The initial state of the action.
* @return A new SimpleAction.
@@ -103,6 +104,7 @@ public:
* must also be bool.
*
* @newin{2,38}
+ *
* @param name The name of the action.
* @param state The initial state of the action.
* @return A new SimpleAction.
@@ -118,6 +120,7 @@ public:
/** Creates a new radio action with a string-based target value.
*
* @newin{2,38}
+ *
* @param name The name of the action.
* @param initial_state The initial state of the action.
* @return A new SimpleAction.
@@ -134,6 +137,7 @@ public:
/** Creates a new radio action with an integer-based target value.
*
* @newin{2,38}
+ *
* @param name The name of the action.
* @param initial_state The initial state of the action.
* @return A new SimpleAction.
diff --git a/gio/src/socket.hg b/gio/src/socket.hg
index 55236a4..530a1ab 100644
--- a/gio/src/socket.hg
+++ b/gio/src/socket.hg
@@ -1,5 +1,3 @@
-// -*- Mode: C++; indent-tabs-mode: nil; c-basic-offset: 2 -*-
-
/* Copyright (C) 2009 Jonathon Jongsma
*
* This library is free software; you can redistribute it and/or
@@ -251,6 +249,7 @@ public:
* Gio::signal_socket().connect() is a simpler interface to the same functionality.
*
* @newin{2,42}
+ *
* @param condition A Glib::IOCondition mask to monitor.
* @param cancellable A Cancellable. The default value means the source is not cancellable.
* @return A newly allocated SocketSource.
diff --git a/glib/src/datetime.hg b/glib/src/datetime.hg
index 601d977..a9c4221 100644
--- a/glib/src/datetime.hg
+++ b/glib/src/datetime.hg
@@ -95,6 +95,7 @@ public:
* TimeSpan that is returned is effectively @a *this - @a other.
*
* @newin{2,26}
+ *
* @param other The other DateTime.
* @return The difference between the two DateTime, as a time
* span expressed in microseconds.
@@ -106,6 +107,7 @@ public:
* as a CompareFunc.
*
* @newin{2,26}
+ *
* @param other The DateTime to compare with.
* @return -1, 0 or 1 if @a *this is less than, equal to or greater
* than @a other.
@@ -120,6 +122,7 @@ public:
* them to the same time zone.
*
* @newin{2,26}
+ *
* @param other The DateTime to compare with.
* @return <tt>true</tt> if @a *this and @a other are equal.
*/
diff --git a/glib/src/glib_docs_override.xml b/glib/src/glib_docs_override.xml
index 77c4d22..9eee106 100644
--- a/glib/src/glib_docs_override.xml
+++ b/glib/src/glib_docs_override.xml
@@ -46,6 +46,7 @@ Loads a key file into an empty KeyFile instance.
If the file could not be loaded then a FileError or KeyFileError exception is thrown.
Since: 2.6
+
\throw Glib::FileError
\throw Glib::KeyFileError
</description>
diff --git a/glib/src/keyfile.hg b/glib/src/keyfile.hg
index 5f7c199..c976a95 100644
--- a/glib/src/keyfile.hg
+++ b/glib/src/keyfile.hg
@@ -263,6 +263,7 @@ public:
* If @a key cannot be found then it is created.
*
* @newin{2,12}
+ *
* @param key A key.
* @param value An double value.
*/
diff --git a/glib/src/variant.hg b/glib/src/variant.hg
index 0cb1a82..be750d0 100644
--- a/glib/src/variant.hg
+++ b/glib/src/variant.hg
@@ -144,6 +144,7 @@ public:
/** Checks if @a *this and @a other have the same type and value.
*
* @newin{2,24}
+ *
* @param other The Variant to compare with.
* @return <tt>true</tt> if @a *this and @a other are equal.
*/
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]