[gstreamermm] Update the README and the Doxygen main page documentation.
- From: José Alburquerque <jaalburqu src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gstreamermm] Update the README and the Doxygen main page documentation.
- Date: Mon, 18 Oct 2010 04:15:42 +0000 (UTC)
commit 6ca463827d0ff9afda934076cd6c2af5b35b9c2f
Author: José Alburquerque <jaalburqu svn gnome org>
Date: Mon Oct 18 00:13:39 2010 -0400
Update the README and the Doxygen main page documentation.
* README: Updated to describe more precisely where the documentation
can be found.
* gstreamer/gstreamermm.h: Updated the Doxygen main page docs to
explain that most of the core and base plug-ins have been wrapped (so
it is not thought that more than a few are not wrapped). Re-worded
the sentence about initializing the library.
ChangeLog | 11 +++++++++++
README | 7 ++++---
gstreamer/gstreamermm.h | 8 ++++----
3 files changed, 19 insertions(+), 7 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index 7fe4620..d7e753a 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,14 @@
+2010-10-18 José Alburquerque <jaalburqu svn gnome org>
+
+ Update the README and the Doxygen main page documentation.
+
+ * README: Updated to describe more precisely where the documentation
+ can be found.
+ * gstreamer/gstreamermm.h: Updated the Doxygen main page docs to
+ explain that most of the core and base plug-ins have been wrapped (so
+ it is not thought that more than a few are not wrapped). Re-worded
+ the sentence about initializing the library.
+
2010-10-17 José Alburquerque <jaalburqu svn gnome org>
Tests: BufferListIterator: Make sure the GType system is initialized.
diff --git a/README b/README
index 2c79519..cefcbf7 100644
--- a/README
+++ b/README
@@ -12,9 +12,10 @@ pointer class, Glib::RefPtr, and libsigc++'s slots are used for callbacks and
signals.
There are several examples, including a media player, in the examples/
-directory, that demonstrate how to use the API and there are API docs in the
-docs/reference/html directory. The core plug-ins, such as Gst::Identity and
-Gst::FileSrc are also provided along with many of the base plug-ins.
+directory, that demonstrate how to use the API. Devhelp and html
+documentation is also provided and the API documentation is also found on
+library.gnome.org. The core plug-ins, such as Gst::Identity and Gst::FileSrc
+are also provided along with many of the base plug-ins.
Dependencies
============
diff --git a/gstreamer/gstreamermm.h b/gstreamer/gstreamermm.h
index a5edcdd..e923bd3 100644
--- a/gstreamer/gstreamermm.h
+++ b/gstreamer/gstreamermm.h
@@ -21,13 +21,13 @@
* - Referencing and unreferencing of GObjects is handled automatically via
* glibmm's automatic pointer class, Glib::RefPtr.
* - libsigc++'s slots are used for callbacks and signals.
- * - Many of the GStreamer core and base plug-ins are wrapped.
+ * - Most of the GStreamer core and base plug-ins are wrapped.
*
* @section Basics Basic Usage
*
- * To use the library, some form of the Gst::init() method must be called
- * before using its classes, functions, etc. To get a deeper understanding of
- * how to set up pipelines, deal with elements, pads, etc., see the <a
+ * Some form of the Gst::init() method must be called before using the
+ * library's classes, functions, etc. To get a deeper understanding of how to
+ * set up pipelines, deal with elements, pads, etc., see the <a
* href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/manual/html/index.html">GStreamer
* Application Development Manual</a>.
*
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]