docs: remove outdated and pointless 'Last reviewed' lines from docs

They are very confusing for people, and more often than not also just not very accurate. Seeing 'last reviewed: 2005' in your docs is not very confidence-inspiring. Let's just remove those comments.
2025-01-03 14:08:56 +00:00 · 2014-04-26 21:21:51 +01:00 · 2014-04-26 21:21:51 +01:00 · 6eb6d9ec38
commit 6eb6d9ec38
parent ec69ad4e8a
53 changed files with 0 additions and 110 deletions
--- a/docs/README
+++ b/docs/README
@ -202,9 +202,6 @@ STYLE GUIDE FOR GTK-DOC
    about threadsafety and related issues
 - link to signals from the description like this:
  * The <link linkend="GstBin-element-added">element-added</link> signal
- the bottom of the description should say when the doc was last reviewed
-  (version and date)
-   * Last reviewed on 2005-10-28 (0.9.4)

 WEBSITE DOCUMENTATION
 =====================
--- a/gst/gst.c
+++ b/gst/gst.c
@ -91,8 +91,6 @@
 * The gst_deinit() call is used to clean up all internal resources used
 * by <application>GStreamer</application>. It is mostly used in unit tests 
 * to check for leaks.
- *
- * Last reviewed on 2006-08-11 (0.10.10)
 */

 #include "gst_private.h"
--- a/gst/gstallocator.c
+++ b/gst/gstallocator.c
@ -35,8 +35,6 @@
 *
 * New memory can be created with gst_memory_new_wrapped() that wraps the memory
 * allocated elsewhere.
- *
- * Last reviewed on 2012-07-09 (0.11.3)
 */

 #ifdef HAVE_CONFIG_H
--- a/gst/gstbin.c
+++ b/gst/gstbin.c
@ -153,8 +153,6 @@
 *
 * </para>
 * </refsect2>
- *
- * Last reviewed on 2012-03-28 (0.11.3)
 */

 #include "gst_private.h"
--- a/gst/gstbuffer.c
+++ b/gst/gstbuffer.c
@ -104,8 +104,6 @@
 * the refcount drops to 0, any memory and metadata pointed to by the buffer is
 * unreffed as well. Buffers allocated from a #GstBufferPool will be returned to
 * the pool when the refcount drops to 0.
- *
- * Last reviewed on 2012-03-28 (0.11.3)
 */
 #include "gst_private.h"

--- a/gst/gstbufferlist.c
+++ b/gst/gstbufferlist.c
@ -33,8 +33,6 @@
 * Buffer lists can be pushed on a srcpad with gst_pad_push_list(). This is
 * interesting when multiple buffers need to be pushed in one go because it
 * can reduce the amount of overhead for pushing each buffer individually.
- *
- * Last reviewed on 2012-03-28 (0.11.3)
 */
 #include "gst_private.h"

--- a/gst/gstbufferpool.c
+++ b/gst/gstbufferpool.c
@ -61,8 +61,6 @@
 *
 * Use gst_object_unref() to release the reference to a bufferpool. If the
 * refcount of the pool reaches 0, the pool will be freed.
- *
- * Last reviewed on 2014-01-30 (1.3.0)
 */

 #include "gst_private.h"
--- a/gst/gstbus.c
+++ b/gst/gstbus.c
@ -63,8 +63,6 @@
 *
 * Note that a #GstPipeline will set its bus into flushing state when changing
 * from READY to NULL state.
- *
- * Last reviewed on 2012-03-28 (0.11.3)
 */

 #include "gst_private.h"
--- a/gst/gstcaps.c
+++ b/gst/gstcaps.c
@ -56,8 +56,6 @@
 * support one level of nesting. Using more levels will lead to unexpected
 * behavior when using serialization features, such as gst_caps_to_string() or
 * gst_value_serialize() and their counterparts.
- *
- * Last reviewed on 2011-03-28 (0.11.3)
 */

 #ifdef HAVE_CONFIG_H
--- a/gst/gstclock.c
+++ b/gst/gstclock.c
@ -98,8 +98,6 @@
 * clock and run the calibration functions. #GstClock:window-size defines the
 * number of samples to use when calibrating and #GstClock:window-threshold
 * defines the minimum number of samples before the calibration is performed.
- *
- * Last reviewed on 2012-03-28 (0.11.3)
 */


--- a/gst/gstelement.c
+++ b/gst/gstelement.c
@ -75,8 +75,6 @@
 * Note that clock selection and distribution is normally handled by the
 * toplevel #GstPipeline so the clock functions are only to be used in very
 * specific situations.
- *
- * Last reviewed on 2012-03-28 (0.11.3)
 */

 #include "gst_private.h"
--- a/gst/gstelementfactory.c
+++ b/gst/gstelementfactory.c
@ -53,8 +53,6 @@
 *   ...
 * </programlisting>
 * </example>
- *
- * Last reviewed on 2005-11-23 (0.9.5)
 */

 #include "gst_private.h"
--- a/gst/gsterror.c
+++ b/gst/gsterror.c
@ -94,8 +94,6 @@
 *     passed.  #GST_ERROR_SYSTEM can be used as a shortcut to give
 *     debug information on a system call error.</para></listitem>
 * </itemizedlist>
- *
- * Last reviewed on 2006-09-15 (0.10.10)
 */

 /* FIXME 0.11: the entire error system needs an overhaul - it's not very
--- a/gst/gstevent.c
+++ b/gst/gstevent.c
@ -68,8 +68,6 @@
 *     g_warning ("seek failed");
 *   ...
 * ]|
- *
- * Last reviewed on 2012-03-28 (0.11.3)
 */


--- a/gst/gstghostpad.c
+++ b/gst/gstghostpad.c
@ -40,8 +40,6 @@
 * association later on.
 *
 * Note that GhostPads add overhead to the data processing of a pipeline.
- *
- * Last reviewed on 2005-11-18 (0.9.5)
 */

 #include "gst_private.h"
--- a/gst/gstiterator.c
+++ b/gst/gstiterator.c
@ -62,8 +62,6 @@
 *   g_value_unset (&amp;item);
 *   gst_iterator_free (it);
 * ]|
- *
- * Last reviewed on 2009-06-16 (0.10.24)
 */

 #include "gst_private.h"
--- a/gst/gstmemory.c
+++ b/gst/gstmemory.c
@ -60,8 +60,6 @@
 * size.
 *
 * Memory can be efficiently merged when gst_memory_is_span() returns TRUE.
- *
- * Last reviewed on 2012-03-28 (0.11.3)
 */

 #ifdef HAVE_CONFIG_H
--- a/gst/gstmessage.c
+++ b/gst/gstmessage.c
@ -40,8 +40,6 @@
 *
 * A #GstElement usually posts messages on the bus provided by the parent
 * container using gst_element_post_message().
- *
- * Last reviewed on 2005-11-09 (0.9.4)
 */


--- a/gst/gstmeta.c
+++ b/gst/gstmeta.c
@ -42,8 +42,6 @@
 *
 * See #GstBuffer for how the metadata can be added, retrieved and removed from
 * buffers.
- *
- * Last reviewed on 2012-03-28 (0.11.3)
 */
 #include "gst_private.h"

--- a/gst/gstminiobject.c
+++ b/gst/gstminiobject.c
@ -47,8 +47,6 @@
 *
 * A weak reference can be added and remove with gst_mini_object_weak_ref()
 * and gst_mini_object_weak_unref() respectively.
- *
- * Last reviewed on 2012-06-15 (0.11.93)
 */
 #ifdef HAVE_CONFIG_H
 #include "config.h"
--- a/gst/gstobject.c
+++ b/gst/gstobject.c
@ -88,8 +88,6 @@
 * </orderedlist>
 * </para>
 * </refsect2>
- *
- * Last reviewed on 2012-03-29 (0.11.3)
 */

 #include "gst_private.h"
--- a/gst/gstpad.c
+++ b/gst/gstpad.c
@ -84,8 +84,6 @@
 * Convenience functions exist to start, pause and stop the task on a pad with
 * gst_pad_start_task(), gst_pad_pause_task() and gst_pad_stop_task()
 * respectively.
- *
- * Last reviewed on 2012-03-29 (0.11.3)
 */

 #include "gst_private.h"
--- a/gst/gstpadtemplate.c
+++ b/gst/gstpadtemplate.c
@ -86,8 +86,6 @@
 *         gst_static_pad_template_get (&amp;my_template));
 *   }
 * ]|
- *
- * Last reviewed on 2006-02-14 (0.10.3)
 */

 #include "gst_private.h"
--- a/gst/gstparamspecs.c
+++ b/gst/gstparamspecs.c
@ -22,8 +22,6 @@
 * to GStreamer
 *
 * GParamSpec implementations specific to GStreamer.
- *
- * Last reviewed on 2008-03-11 (0.10.18)
 */

 #ifdef HAVE_CONFIG_H
--- a/gst/gstpipeline.c
+++ b/gst/gstpipeline.c
@ -71,8 +71,6 @@
 * between the clock time and the base time) will count how much time was spent
 * in the PLAYING state. This default behaviour can be changed with the
 * gst_element_set_start_time() method.
- *
- * Last reviewed on 2012-03-29 (0.11.3)
 */

 #include "gst_private.h"
--- a/gst/gstquery.c
+++ b/gst/gstquery.c
@ -50,8 +50,6 @@
 *   }
 *   gst_query_unref (query);
 * ]|
- *
- * Last reviewed on 2012-03-29 (0.11.3)
 */


--- a/gst/gstregistry.c
+++ b/gst/gstregistry.c
@ -104,8 +104,6 @@
 * stored in the default registry, and plugins not relevant to the current
 * process are marked with the %GST_PLUGIN_FLAG_CACHED bit. These plugins are
 * removed at the end of initialization.
- *
- * Last reviewed on 2012-03-29 (0.11.3)
 */

 #ifdef HAVE_CONFIG_H
--- a/gst/gstsample.c
+++ b/gst/gstsample.c
@ -26,8 +26,6 @@
 *
 * A #GstSample is a small object containing data, a type, timing and
 * extra arbitrary information.
- *
- * Last reviewed on 2012-03-29 (0.11.3)
 */
 #include "gst_private.h"

--- a/gst/gstsegment.c
+++ b/gst/gstsegment.c
@ -79,8 +79,6 @@
 * For elements that need to perform operations on media data in stream_time,
 * gst_segment_to_stream_time() can be used to convert a timestamp and the segment
 * info to stream time (which is always between 0 and the duration of the stream).
- *
- * Last reviewed on 2012-03-29 (0.11.3)
 */

 /**
--- a/gst/gststructure.c
+++ b/gst/gststructure.c
@ -58,8 +58,6 @@
 * support one level of nesting. Using more levels will lead to unexpected
 * behavior when using serialization features, such as gst_caps_to_string() or
 * gst_value_serialize() and their counterparts.
- *
- * Last reviewed on 2012-03-29 (0.11.3)
 */

 #ifdef HAVE_CONFIG_H
--- a/gst/gstsystemclock.c
+++ b/gst/gstsystemclock.c
@ -34,8 +34,6 @@
 * Subclasses can however override all of the important methods for sync and
 * async notifications to implement their own callback methods or blocking
 * wait operations.
- *
- * Last reviewed on 2006-03-08 (0.10.4)
 */

 #include "gst_private.h"
--- a/gst/gsttagsetter.c
+++ b/gst/gsttagsetter.c
@ -64,8 +64,6 @@
 *  
 * GST_LOG_OBJECT (tagsetter, "final tags: %" GST_PTR_FORMAT, result);
 * ]|
- * 
- * Last reviewed on 2006-05-18 (0.10.6)
 */

 #ifdef HAVE_CONFIG_H
--- a/gst/gsttask.c
+++ b/gst/gsttask.c
@ -64,8 +64,6 @@
 * name on Linux. Please note that the object name should be configured before the
 * task is started; changing the object name after the task has been started, has
 * no effect on the thread name.
- *
- * Last reviewed on 2012-03-29 (0.11.3)
 */

 #include "gst_private.h"
--- a/gst/gsttaskpool.c
+++ b/gst/gsttaskpool.c
@ -28,8 +28,6 @@
 * implementation uses a regular GThreadPool to start tasks.
 *
 * Subclasses can be made to create custom threads.
- *
- * Last reviewed on 2009-04-23 (0.10.24)
 */

 #include "gst_private.h"
--- a/gst/gsttypefind.c
+++ b/gst/gsttypefind.c
@ -25,8 +25,6 @@
 *
 * The following functions allow you to detect the media type of an unknown
 * stream.
- *
- * Last reviewed on 2005-11-09 (0.9.4)
 */

 #include "gst_private.h"
--- a/gst/gsttypefindfactory.c
+++ b/gst/gsttypefindfactory.c
@ -72,8 +72,6 @@
 *     return find.caps;
 *   };
 * ]|
- *
- * Last reviewed on 2005-11-09 (0.9.4)
 */

 #include "gst_private.h"
--- a/gst/gsturi.c
+++ b/gst/gsturi.c
@ -33,8 +33,6 @@
 * (gst_element_make_from_uri()).
 *
 * Source and Sink plugins should implement this interface when possible.
- *
- * Last reviewed on 2005-11-09 (0.9.4)
 */

 #ifdef HAVE_CONFIG_H
--- a/gst/gstvalue.c
+++ b/gst/gstvalue.c
@ -26,8 +26,6 @@
 *
 * Note that operations on the same #GValue from multiple threads may lead to
 * undefined behaviour.
- *
- * Last reviewed on 2008-03-11 (0.10.18)
 */

 #ifdef HAVE_CONFIG_H
--- a/libs/gst/base/gstadapter.c
+++ b/libs/gst/base/gstadapter.c
@ -109,8 +109,6 @@
 * gst_buffer_ref() before pushing it into the adapter if you still want to
 * access the buffer later. The adapter will never modify the data in the
 * buffer pushed in it.
- *
- * Last reviewed on 2009-05-13 (0.10.24).
 */

 #include <gst/gst_private.h>
--- a/libs/gst/base/gstbasesink.c
+++ b/libs/gst/base/gstbasesink.c
@ -138,8 +138,6 @@
 * The #GstBaseSink:async property can be used to instruct the sink to never
 * perform an ASYNC state change. This feature is mostly usable when dealing
 * with non-synchronized streams or sparse streams.
- *
- * Last reviewed on 2007-08-29 (0.10.15)
 */

 #ifdef HAVE_CONFIG_H
--- a/libs/gst/base/gstbasesrc.c
+++ b/libs/gst/base/gstbasesrc.c
@ -150,8 +150,6 @@
 * After the EOS has been sent to the element, the application should wait for
 * an EOS message to be posted on the pipeline's bus. Once this EOS message is
 * received, it may safely shut down the entire pipeline.
- *
- * Last reviewed on 2007-12-19 (0.10.16)
 * </para>
 * </refsect2>
 */
--- a/libs/gst/base/gstcollectpads.c
+++ b/libs/gst/base/gstcollectpads.c
@ -71,8 +71,6 @@
 *     All pads are in waiting mode by default.
 *   </para></listitem>
 * </itemizedlist>
- *
- * Last reviewed on 2011-10-28 (0.10.36)
 */

 #ifdef HAVE_CONFIG_H
--- a/libs/gst/base/gstpushsrc.c
+++ b/libs/gst/base/gstpushsrc.c
@ -44,8 +44,6 @@
 *
 * Seeking, flushing, scheduling and sync is all handled by this
 * base class.
- *
- * Last reviewed on 2006-07-04 (0.10.9)
 */

 #ifdef HAVE_CONFIG_H
--- a/libs/gst/net/gstnetaddressmeta.c
+++ b/libs/gst/net/gstnetaddressmeta.c
@ -24,8 +24,6 @@
 * #GstNetAddress can be used to store a network address. #GstNetAddressMeta can
 * be used to store a network address in a #GstBuffer so that it network
 * elements can track the to and from address of the buffer.
- *
- * Last reviewed on 2011-11-03 (0.11.2)
 */

 #include <string.h>
--- a/libs/gst/net/gstnetclientclock.c
+++ b/libs/gst/net/gstnetclientclock.c
@ -45,8 +45,6 @@
 *
 * A #GstNetClientClock is typically set on a #GstPipeline with 
 * gst_pipeline_use_clock().
- *
- * Last reviewed on 2005-11-23 (0.9.5)
 */

 #ifdef HAVE_CONFIG_H
--- a/libs/gst/net/gstnettimepacket.c
+++ b/libs/gst/net/gstnettimepacket.c
@ -26,8 +26,6 @@
 *
 * Various functions for receiving, sending an serializing #GstNetTimePacket
 * structures.
- *
- * Last reviewed on 2005-11-23 (0.9.5)
 */

 #ifdef HAVE_CONFIG_H
--- a/libs/gst/net/gstnettimeprovider.c
+++ b/libs/gst/net/gstnettimeprovider.c
@ -31,8 +31,6 @@
 * query the exposed clock over the network for its values.
 *
 * The #GstNetTimeProvider typically wraps the clock used by a #GstPipeline.
- *
- * Last reviewed on 2005-11-23 (0.9.5)
 */

 #ifdef HAVE_CONFIG_H
--- a/plugins/elements/gstfakesrc.c
+++ b/plugins/elements/gstfakesrc.c
@ -36,8 +36,6 @@
 * ]| This pipeline will push 5 empty buffers to the fakesink element and then
 * sends an EOS.
 * </refsect2>
- *
- * Last reviewed on 2008-06-20 (0.10.21)
 */

 /* FIXME: this ignores basesrc::blocksize property, which could be used as an
--- a/plugins/elements/gstfdsink.c
+++ b/plugins/elements/gstfdsink.c
@ -29,8 +29,6 @@
 * This element will synchronize on the clock before writing the data on the
 * socket. For file descriptors where this does not make sense (files, ...) the
 * #GstBaseSink:sync property can be used to disable synchronisation.
- *
- * Last reviewed on 2006-04-28 (0.10.6)
 */

 #ifdef HAVE_CONFIG_H
--- a/plugins/elements/gstfdsrc.c
+++ b/plugins/elements/gstfdsrc.c
@ -51,8 +51,6 @@
 * ]| A simple pipeline to read from the standard input and dump the data
 * with a fakesink as hex ascii block.
 * </refsect2>
- *
- * Last reviewed on 2008-06-20 (0.10.21)
 */

 #ifdef HAVE_CONFIG_H
--- a/plugins/elements/gstmultiqueue.c
+++ b/plugins/elements/gstmultiqueue.c
@ -101,8 +101,6 @@
 *   Both signals are emitted from the context of the streaming thread.
 * </para>
 * </refsect2>
- *
- * Last reviewed on 2008-01-25 (0.10.17)
 */

 #ifdef HAVE_CONFIG_H
--- a/plugins/elements/gstqueue2.c
+++ b/plugins/elements/gstqueue2.c
@ -48,8 +48,6 @@
 *
 * The temp-location property will be used to notify the application of the
 * allocated filename.
- *
- * Last reviewed on 2009-07-10 (0.10.24)
 */

 #ifdef HAVE_CONFIG_H
--- a/plugins/elements/gstvalve.c
+++ b/plugins/elements/gstvalve.c
@ -29,11 +29,6 @@
 * Any downstream error received while the #GstValve:drop property is %FALSE
 * is ignored. So downstream element can be set to  %GST_STATE_NULL and removed,
 * without using pad blocking.
- *
- * This element was previously part of gst-plugins-farsight, and then
- * gst-plugins-bad.
- *
- * Documentation last reviewed on 2010-12-30 (0.10.31)
 */

 #ifdef HAVE_CONFIG_H