qt-gstreamer: Move the connect() design docs to a txt file.

George Kiagiadakis gkiagia at kemper.freedesktop.org
Sun Mar 6 13:08:55 PST 2011


Module: qt-gstreamer
Branch: master
Commit: 834407d9f5cabf2fd2b2c2cc694cc95d1ecb1982
URL:    http://cgit.freedesktop.org/gstreamer/qt-gstreamer/commit/?id=834407d9f5cabf2fd2b2c2cc694cc95d1ecb1982

Author: George Kiagiadakis <george.kiagiadakis at collabora.co.uk>
Date:   Sun Mar  6 20:35:47 2011 +0200

Move the connect() design docs to a txt file.

---

 docs/design/connect.txt |    5 +++++
 src/main.dox            |   10 +++-------
 2 files changed, 8 insertions(+), 7 deletions(-)

diff --git a/docs/design/connect.txt b/docs/design/connect.txt
new file mode 100644
index 0000000..5bdf245
--- /dev/null
+++ b/docs/design/connect.txt
@@ -0,0 +1,5 @@
+connect() is a template method. When it is used, it takes the arguments of the given
+slot and instantiates a template marshaller that is responsible for converting
+the GValues that the signal provides to the C++ types that the slot expects.
+This marshaller and the structure holding the receiver & slot are then attached on
+the data of a GClosure and this GClosure is connected to the signal.
diff --git a/src/main.dox b/src/main.dox
index 4d4552f..cfb5384 100644
--- a/src/main.dox
+++ b/src/main.dox
@@ -167,16 +167,12 @@
  * in contributing to the library itself or who are just interesting in learning how
  * some things work.
  *
- * \section connect_design Connect Design
- * connect() is a template method. When it is used, it takes the arguments of the given
- * slot and instantiates a template marshaller that is responsible for converting
- * the GValues that the signal provides to the C++ types that the slot expects.
- * This marshaller and the structure holding the receiver & slot are then attached on
- * the data of a GClosure and this GClosure is connected to the signal.
- *
  * \section wrap_design Wrapping System Design
  * \include docs/design/wrap.txt
  *
  * \section value_design Value Design
  * \include docs/design/gvalue.txt
+ *
+ * \section connect_design Connect Design
+ * \include docs/design/connect.txt
  */



More information about the gstreamer-commits mailing list