* doc/Makefile.am: Write a little bit of documentation.

* doc/liboil-overrides.txt:
* doc/liboil-sections.txt:
* doc/tmpl/liboil-unused.sgml:
* doc/tmpl/liboil.sgml:
* doc/tmpl/liboilfuncs-conv.sgml:
* doc/tmpl/liboilfuncs-copy.sgml:
* doc/tmpl/liboilfuncs-dct.sgml:
* doc/tmpl/liboilfuncs-doc.sgml:
* doc/tmpl/liboilfuncs-math.sgml:
* doc/tmpl/liboilfuncs-math8x8.sgml:
* doc/tmpl/liboilfuncs-pixel.sgml:
* doc/tmpl/liboilfunction.sgml:
* doc/tmpl/liboilparameter.sgml:
* doc/tmpl/liboilprofile.sgml:
* doc/tmpl/liboiltest.sgml:
* doc/tmpl/liboiltypes.sgml:
* liboil/dct/dct12_f32.c:
* liboil/dct/dct36_f32.c:
* liboil/dct/fdct8_f64.c:
* liboil/dct/fdct8x8_f64.c:
* liboil/dct/fdct8x8s_s16.c:
* liboil/dct/fdct8x8theora.c:
* liboil/dct/idct8_f64.c:
* liboil/dct/idct8x8_c.c:
* liboil/dct/idct8x8theora_ref.c:
* liboil/dct/imdct32_f32.c:
* liboil/jpeg/convert8x8_c.c:
* liboil/jpeg/jpeg_rgb_decoder.c:
* liboil/jpeg/quantize8x8_c.c:
* liboil/jpeg/zigzag8x8_c.c:
* liboil/liboilclasses.h:
* liboil/liboilcolorspace.h:
* liboil/liboilcpu.c: (oil_cpu_fault_check_enable):
* liboil/liboildebug.c:
* liboil/liboildebug.h:
* liboil/liboilfuncs.h:
* liboil/liboilfunction.c:
* liboil/liboilfunction.h:
* liboil/liboilparameter.h:
* liboil/liboilprofile.c:
* liboil/liboilprofile.h:
* liboil/liboilprototype.c: (oil_prototype_to_string),
(oil_prototype_from_string):
* liboil/liboilprototype.h:
* liboil/liboilrandom.h:
* liboil/liboiltest.c:
* liboil/liboiltest.h:
* liboil/liboiltypes.h:
* liboil/md5/md5.c:
* liboil/null.c:
* liboil/ref/average2_u8.c:
* liboil/ref/clip_ref.c:
* liboil/ref/composite.c:
* liboil/ref/conv.c:
* liboil/ref/copy.c:
* liboil/ref/copy8x8.c:
* liboil/ref/diff8x8.c:
* liboil/ref/diffsquaresum_f64.c:
* liboil/ref/error8x8.c:
* liboil/ref/math.c:
* liboil/ref/mix_u8.c:
* liboil/ref/mult8x8_s16.c:
* liboil/ref/multsum.c:
* liboil/ref/permute.c:
* liboil/ref/recon8x8.c:
* liboil/ref/resample.c:
* liboil/ref/rowcolsad8x8.c:
* liboil/ref/sad8x8.c:
* liboil/ref/sad8x8_broken.c:
* liboil/ref/sad8x8avg.c:
* liboil/ref/scalaradd.c:
* liboil/ref/scalarmult.c:
* liboil/ref/sincos_f64.c:
* liboil/ref/splat.c:
* liboil/ref/squaresum_f64.c:
* liboil/ref/sum_f64.c:
* liboil/ref/tablelookup.c:
* liboil/ref/trans8x8.c:
* liboil/ref/vectoradd_f64.c:
* liboil/ref/vectoradd_s.c:
* liboil/utf8/utf8.c:

1 files changed, 39 insertions, 0 deletions

diff --git a/liboil/liboilprofile.c b/liboil/liboilprofile.c
index c15a5ec..352d6f8 100644
--- a/liboil/liboilprofile.c
+++ b/liboil/liboilprofile.c
@@ -36,6 +36,20 @@
 #include <string.h>
 #include <math.h>
 
+/**
+ * SECTION:liboilprofile
+ * @short_description:
+ * Measuring the length of time needed to execute Liboil functions.
+ *
+ */
+
+/**
+ * oil_profile_stamp_gtod:
+ *
+ * Creates a timestamp using the function gettimofday().
+ *
+ * Returns: a timestamp
+ */
 unsigned long oil_profile_stamp_gtod (void)
 {
 #ifdef HAVE_GETTIMEOFDAY
@@ -47,6 +61,12 @@ unsigned long oil_profile_stamp_gtod (void)
 #endif
 }
 
+/**
+ * oil_profile_init:
+ * @prof: the OilProfile structure
+ *
+ * Initializes a profiling structure.
+ */
 void
 oil_profile_init (OilProfile *prof)
 {
@@ -56,6 +76,14 @@ oil_profile_init (OilProfile *prof)
 
 }
 
+/**
+ * oil_profile_stop_handle:
+ * @prof: the OilProfile structure
+ *
+ * Handles post-processing of a single profiling run.
+ *
+ * FIXME: need more info
+ */
 void
 oil_profile_stop_handle (OilProfile *prof)
 {
@@ -81,6 +109,17 @@ oil_profile_stop_handle (OilProfile *prof)
   }
 }
 
+/**
+ * oil_profile_get_ave_std:
+ * @prof: the OilProfile structure
+ * @ave_p: pointer to average
+ * @std_p: pointer to standard deviation
+ *
+ * Calculates the average and standard deviation of a number of
+ * profiling runs, and places the results in the locations
+ * provided by @ave_p and @std_p.  Either @ave_p and @std_p may
+ * be NULL, in which case the values will not be written.
+ */
 void
 oil_profile_get_ave_std (OilProfile *prof, double *ave_p, double *std_p)
 {