Docs triage scratch space
As part of fixing up our API docs, we need to know their current status. This page is a way of listing all files that are documented, and splitting up the triage. Update the list below when you triage.
schedule
There are about 150 files below that need review. Maybe 10% of these files are private, which leaves about 135 files. Reviewing each one will take about half an hour apiece maybe. We have four weeks to review these files, meaning about 18 hours a week. If we are +/- 6 people reviewing documentation that means that each hacker should spend 3 hours each week during the month of November reviewing documentation.
Plan accordingly!
status values
Standard values for status:
unknown -- when a file hasn't been triaged yet
private -- when a file exports no public api, and you have checked that nothing mentions symbols from this file in gstreamer-sections.txt
good -- when the file is already fine (haha)
in progress -- when you're in the middle of reviewing a file, to avoid multiple people reviewing the same file at the same time. Please add your name as well, if you set this.
- otherwise a list of changes needed, with specific function names
Also note the status of the overview section (the one that goes in <description> in the docbook). If one is completely absent, note that too.
editing guidelines
be sure you have read the GStreamer gtkdoc style guide
also take a look at the upstream gtkdoc style guide
- edit once when you start triaging a file to say that you're on it, and put your name
- take notes offline while you are looking at then file
edit again to update with the status of the file, and put your name so we know who did it
core api docs
file |
status |
gettext.h |
private -- skaboy |
glib-compat.c |
private -- skaboy |
glib-compat.h |
private -- skaboy |
gstbin.c |
in progress -- thomasvs |
gstbin.h |
good -- wtay |
gstbuffer.c |
fixed and spiffified by mikes |
gstbuffer.h |
fixed and uber-spiffy-spiffified by wtay |
gstbus.c |
fixed -- reviewed by dolphy |
gstbus.h |
good -- reviewed by dolphy |
gst.c |
fixed -- skaboy |
gstcaps.c |
good - wtay |
gstcaps.h |
good - wtay |
gstchildproxy.c |
unknown |
gstchildproxy.h |
unknown |
gstclock.c |
good -- wtay |
gstclock.h |
good -- wtay |
gstcompat.h |
unknown |
gstconfig.h |
unknown |
gstelement.c |
good -- wtay |
gstelement.h |
good -- wtay |
gstelementfactory.c |
unknown |
gstelementfactory.h |
unknown |
gstenumtypes.c |
unknown |
gstenumtypes.h |
unknown |
gsterror.c |
unknown |
gsterror.h |
unknown |
gstevent.c |
good -- wtay |
gstevent.h |
good -- wtay |
gstfilter.c |
unknown |
gstfilter.h |
unknown |
gstformat.c |
unknown |
gstformat.h |
unknown |
gstghostpad.c |
unknown |
gstghostpad.h |
unknown |
gst.h |
unknown |
gst-i18n-app.h |
unknown |
gst-i18n-lib.h |
unknown |
gstindex.c |
unknown |
gstindexfactory.c |
unknown |
gstindexfactory.h |
unknown |
gstindex.h |
unknown |
gstinfo.c |
good -- reviewed by ensonic |
gstinfo.h |
good -- reviewed by ensonic |
gstinterface.c |
unknown |
gstinterface.h |
unknown |
gstiterator.c |
good -- wtay |
gstiterator.h |
good -- wtay |
gstmacros.h |
unknown |
gstmarshal.c |
unknown |
gstmarshal.h |
unknown |
gstmessage.c |
good -- wtay |
gstmessage.h |
good -- wtay |
gstminiobject.c |
fixed -- reviewed by ensonic |
gstminiobject.h |
fixed -- reviewed by ensonic |
gstobject.c |
good -- wtay |
gstobject.h |
good -- wtay |
gstpad.c |
unknown |
gstpad.h |
6 GST_STREAM_ macros need docs |
gstpadtemplate.c |
unknown |
gstpadtemplate.h |
unknown |
gstparse.c |
unknown |
gstparse.h |
unknown |
gstpipeline.c |
unknown |
gstpipeline.h |
unknown |
gstplugin.c |
unknown |
gstpluginfeature.c |
unknown |
gstpluginfeature.h |
unknown |
gstplugin.h |
unknown |
gst_private.h |
unknown |
gstquery.c |
unknown |
gstquery.h |
unknown |
gstqueue.c |
unknown |
gstqueue.h |
unknown |
gstregistry.c |
7 gst_default_registry_ functions need docs |
gstregistry.h |
unknown |
gstregistryxml.c |
unknown |
gststructure.c |
good -- wtay |
gststructure.h |
good -- wtay |
gstsystemclock.c |
unknown |
gstsystemclock.h |
unknown |
gsttaglist.c |
unknown |
gsttaglist.h |
unknown |
gsttagsetter.c |
unknown |
gsttagsetter.h |
unknown |
gsttask.c |
good -- wtay |
gsttask.h |
good -- wtay |
gsttrace.c |
lacks summary docs, seems to be a memory debugging facillity |
gsttrace.h |
unknown |
gsttypefind.c |
done -- bilboed |
gsttypefindfactory.c |
done -- bilboed |
gsttypefindfactory.h |
done -- bilboed |
gsttypefind.h |
done -- bilboed |
gsturi.c |
fixed, This in an interface, shouldn't it be documented in a different way ? -- bilboed |
gsturi.h |
fixed -- bilboed |
gsturitype.c |
This defines the GST_URI_TYPE ... which isn't used anywhere. Filed bug #321061 about this problem -- bilboed |
gsturitype.h |
private -- bilboed |
gstutils.c |
unknown |
gstutils.h |
unknown |
gstvalue.c |
unknown |
gstvalue.h |
unknown |
gstversion.h |
good, nothing to do -- bilboed |
gstxml.c |
unknown |
gstxml.h |
unknown |
base class api docs
file |
status |
gstadapter.c |
good -- wingo |
gstadapter.h |
good -- wingo |
gstbasesink.c |
in progress -- wingo |
gstbasesink.h |
in progress -- wingo |
gstbasesrc.c |
unknown |
gstbasesrc.h |
unknown |
gstbasetransform.c |
unknown |
gstbasetransform.h |
unknown |
gstcollectpads.c |
unknown |
gstcollectpads.h |
unknown |
gstpushsrc.c |
unknown |
gstpushsrc.h |
unknown |
gsttypefindhelper.c |
done -- bilboed |
gsttypefindhelper.h |
done -- bilboed |
core element api docs
file |
status |
gstbufferstore.c |
unknown |
gstbufferstore.h |
unknown |
gstcapsfilter.c |
unknown |
gstelements.c |
unknown |
gstfakesink.c |
unknown |
gstfakesink.h |
unknown |
gstfakesrc.c |
unknown |
gstfakesrc.h |
unknown |
gstfdsink.c |
unknown |
gstfdsink.h |
unknown |
gstfdsrc.c |
unknown |
gstfdsrc.h |
unknown |
gstfilesink.c |
unknown |
gstfilesink.h |
unknown |
gstfilesrc.c |
unknown |
gstfilesrc.h |
unknown |
gstidentity.c |
unknown |
gstidentity.h |
unknown |
gsttee.c |
unknown |
gsttee.h |
unknown |
gsttypefindelement.c |
unknown |
gsttypefindelement.h |
unknown |
libs api docs
file |
status |
gstcontroller.c |
unknown |
gstcontroller.h |
unknown |
gsthelper.c |
unknown |
gstinterpolation.c |
unknown |
lib.c |
unknown |
file |
status |
dataprotocol.c |
unknown |
dataprotocol.h |
unknown |
dp-private.h |
unknown |