gstlal; prepare elements for documenting

gstlal/gst/lal/gstlal_audioundersample.h

@@ -48,12 +48,16 @@ G_BEGIN_DECLS
 	(G_TYPE_CHECK_CLASS_TYPE((klass), GSTLAL_AUDIOUNDERSAMPLE_TYPE))
 
 
-typedef struct {
-	GstBaseTransformClass parent_class;
-} GSTLALAudioUnderSampleClass;
+typedef struct _GSTLALAudioUnderSample GSTLALAudioUnderSample;
+typedef struct _GSTLALAudioUnderSampleClass GSTLALAudioUnderSampleClass;
+
 
+/**
+ * GSTLALAudioUnderSample:
+ */
 
-typedef struct GSTLALAudioUnderSample {
+
+struct _GSTLALAudioUnderSample {
 	GstBaseTransform element;
 
 	/*
@@ -79,7 +83,17 @@ typedef struct GSTLALAudioUnderSample {
 	 */
 
 	guint64 remainder;
-} GSTLALAudioUnderSample;
+};
+
+
+/**
+ * GSTLALAudioUnderSampleClass
+ */
+
+
+struct _GSTLALAudioUnderSampleClass {
+	GstBaseTransformClass parent_class;
+};
 
 
 GType gstlal_audioundersample_get_type(void);

gstlal/gst/lal/gstlal_autochisq.h

@@ -71,15 +71,13 @@ G_BEGIN_DECLS
 	(G_TYPE_CHECK_CLASS_TYPE((klass), GSTLAL_AUTOCHISQ_TYPE))
 
 
-typedef struct _GSTLALAutoChiSqClass GSTLALAutoChiSqClass;
 typedef struct _GSTLALAutoChiSq GSTLALAutoChiSq;
+typedef struct _GSTLALAutoChiSqClass GSTLALAutoChiSqClass;
 
 
-struct _GSTLALAutoChiSqClass {
-	GstBaseTransformClass parent_class;
-
-	void (*rate_changed)(GSTLALAutoChiSq *, gint, void *);
-};
+/**
+ * GSTLALAutoChiSq:
+ */
 
 
 struct _GSTLALAutoChiSq {
@@ -121,6 +119,18 @@ struct _GSTLALAutoChiSq {
 };
 
 
+/**
+ * GSTLALAutoChiSqClass:
+ */
+
+
+struct _GSTLALAutoChiSqClass {
+	GstBaseTransformClass parent_class;
+
+	void (*rate_changed)(GSTLALAutoChiSq *, gint, void *);
+};
+
+
 GType gstlal_autochisq_get_type(void);
 
 

gstlal/gst/lal/gstlal_cachesrc.h

@@ -66,17 +66,12 @@ G_BEGIN_DECLS
 	(G_TYPE_CHECK_CLASS_TYPE((klass), GSTLAL_CACHESRC_TYPE))
 
 
-typedef struct _GstLALCacheSrcClass GstLALCacheSrcClass;
 typedef struct _GstLALCacheSrc GstLALCacheSrc;
-
-
-struct _GstLALCacheSrcClass {
-	GstBaseSrcClass parent_class;
-};
+typedef struct _GstLALCacheSrcClass GstLALCacheSrcClass;
 
 
 /**
- * GstLALCacheSrc
+ * GstLALCacheSrc:
  */
 
 
@@ -94,6 +89,16 @@ struct _GstLALCacheSrc {
 };
 
 
+/**
+ * GstLALCacheSrcClass:
+ */
+
+
+struct _GstLALCacheSrcClass {
+	GstBaseSrcClass parent_class;
+};
+
+
 /*
  * ============================================================================
  *

gstlal/gst/lal/gstlal_drop.h

@@ -42,12 +42,16 @@ G_BEGIN_DECLS
 	(G_TYPE_CHECK_CLASS_TYPE((klass), GSTLAL_DROP_TYPE))
 
 
-typedef struct {
-	GstElementClass parent_class;
-} GSTLALDropClass;
+typedef struct _GSTLALDrop GSTLALDrop;
+typedef struct _GSTLALDropClass GSTLALDropClass;
+
 
+/**
+ * GSTLALDrop:
+ */
 
-typedef struct _GSTLALDrop {
+
+struct _GSTLALDrop {
 	GstElement element;
 
 	GstPad *sinkpad;
@@ -56,7 +60,17 @@ typedef struct _GSTLALDrop {
 	gint rate;
 	gint unit_size;
 	guint drop_samples;
-} GSTLALDrop;
+};
+
+
+/**
+ * GSTLALDropClass:
+ */
+
+
+struct _GSTLALDropClass {
+	GstElementClass parent_class;
+};
 
 
 GType gstlal_drop_get_type(void);

gstlal/gst/lal/gstlal_firbank.h

@@ -57,15 +57,13 @@ G_BEGIN_DECLS
 	(G_TYPE_CHECK_CLASS_TYPE((klass), GSTLAL_FIRBANK_TYPE))
 
 
-typedef struct _GSTLALFIRBankClass GSTLALFIRBankClass;
 typedef struct _GSTLALFIRBank GSTLALFIRBank;
+typedef struct _GSTLALFIRBankClass GSTLALFIRBankClass;
 
 
-struct _GSTLALFIRBankClass {
-	GstBaseTransformClass parent_class;
-
-	void (*rate_changed)(GSTLALFIRBank *, gint, void *);
-};
+/**
+ * GSTLALFIRBank:
+ */
 
 
 struct _GSTLALFIRBank {
@@ -131,6 +129,18 @@ struct _GSTLALFIRBank {
 };
 
 
+/**
+ * GSTLALFIRBankClass:
+ */
+
+
+struct _GSTLALFIRBankClass {
+	GstBaseTransformClass parent_class;
+
+	void (*rate_changed)(GSTLALFIRBank *, gint, void *);
+};
+
+
 GType gstlal_firbank_get_type(void);
 
 

gstlal/gst/lal/gstlal_gate.h

@@ -43,17 +43,13 @@ G_BEGIN_DECLS
 	(G_TYPE_CHECK_CLASS_TYPE((klass), GSTLAL_GATE_TYPE))
 
 
-typedef struct _GSTLALGateClass GSTLALGateClass;
 typedef struct _GSTLALGate GSTLALGate;
+typedef struct _GSTLALGateClass GSTLALGateClass;
 
 
-struct _GSTLALGateClass {
-	GstElementClass parent_class;
-
-	void (*rate_changed)(GSTLALGate *, gint, void *);
-	void (*start)(GSTLALGate *, guint64, void *);
-	void (*stop)(GSTLALGate *, guint64, void *);
-};
+/**
+ * GSTLALGate:
+ */
 
 
 struct _GSTLALGate {
@@ -87,6 +83,20 @@ struct _GSTLALGate {
 };
 
 
+/**
+ * GSTLALGateClass:
+ */
+
+
+struct _GSTLALGateClass {
+	GstElementClass parent_class;
+
+	void (*rate_changed)(GSTLALGate *, gint, void *);
+	void (*start)(GSTLALGate *, guint64, void *);
+	void (*stop)(GSTLALGate *, guint64, void *);
+};
+
+
 GType gstlal_gate_get_type(void);
 
 

gstlal/gst/lal/gstlal_matrixmixer.h

@@ -46,12 +46,16 @@ G_BEGIN_DECLS
 	(G_TYPE_CHECK_CLASS_TYPE((klass), GSTLAL_MATRIXMIXER_TYPE))
 
 
-typedef struct {
-	GstBaseTransformClass parent_class;
-} GSTLALMatrixMixerClass;
+typedef struct _GSTLALMatrixMixer GSTLALMatrixMixer;
+typedef struct _GSTLALMatrixMixerClass GSTLALMatrixMixerClass;
+
 
+/**
+ * GSTLALMatrixMixer:
+ */
 
-typedef struct {
+
+struct _GSTLALMatrixMixer {
 	GstBaseTransform element;
 
 	/*
@@ -96,7 +100,17 @@ typedef struct {
 		GSTLAL_MATRIXMIXER_COMPLEX_FLOAT,
 		GSTLAL_MATRIXMIXER_COMPLEX_DOUBLE
 	} data_type;
-} GSTLALMatrixMixer;
+};
+
+
+/**
+ * GSTLALMatrixMixerClass:
+ */
+
+
+struct _GSTLALMatrixMixerClass {
+	GstBaseTransformClass parent_class;
+};
 
 
 GType gstlal_matrixmixer_get_type(void);

gstlal/gst/lal/gstlal_nofakedisconts.h

@@ -42,12 +42,16 @@ G_BEGIN_DECLS
 	(G_TYPE_CHECK_CLASS_TYPE((klass), GSTLAL_NOFAKEDISCONTS_TYPE))
 
 
-typedef struct {
-	GstElementClass parent_class;
-} GSTLALNoFakeDiscontsClass;
+typedef struct _GSTLALNoFakeDisconts GSTLALNoFakeDisconts;
+typedef struct _GSTLALNoFakeDiscontsClass GSTLALNoFakeDiscontsClass;
+
 
+/**
+ * GSTLALNoFakeDisconts:
+ */
 
-typedef struct _GSTLALNoFakeDisconts {
+
+struct _GSTLALNoFakeDisconts {
 	GstElement element;
 
 	GstPad *sinkpad;
@@ -56,7 +60,17 @@ typedef struct _GSTLALNoFakeDisconts {
 	guint64 next_offset;
 	guint64 next_timestamp;
 	gboolean silent;
-} GSTLALNoFakeDisconts;
+};
+
+
+/**
+ * GSTLALNoFakeDiscontsClass:
+ */
+
+
+struct _GSTLALNoFakeDiscontsClass {
+	GstElementClass parent_class;
+};
 
 
 GType gstlal_nofakedisconts_get_type(void);

gstlal/gst/lal/gstlal_nxydump.h

@@ -40,13 +40,16 @@ G_BEGIN_DECLS
 	(G_TYPE_CHECK_CLASS_TYPE((klass), GST_TSVENC_TYPE))
 
 
-typedef struct
-{
-  GstBaseTransformClass parent_class;
-} GstTSVEncClass;
+typedef struct _GstTSVEnc GstTSVEnc;
+typedef struct _GstTSVEncClass GstTSVEncClass;
+
+
+/**
+ * GstTSVEnc:
+ */
 
 
-typedef struct
+struct _GstTSVEnc
 {
   GstBaseTransform element;
 
@@ -57,7 +60,18 @@ typedef struct
 
   GstClockTime start_time;
   GstClockTime stop_time;
-} GstTSVEnc;
+};
+
+
+/**
+ * GstTSVEncClass:
+ */
+
+
+struct _GstTSVEncClass
+{
+  GstBaseTransformClass parent_class;
+};
 
 
 GType gst_tsvenc_get_type(void);

gstlal/gst/lal/gstlal_peak.h

@@ -52,13 +52,16 @@ G_BEGIN_DECLS
 	(G_TYPE_CHECK_CLASS_TYPE((klass), GSTLAL_PEAK_TYPE))
 
 
-typedef struct {
-	GstElementClass parent_class;
-} GSTLALPeakClass;
+typedef struct _GSTLALPeak GSTLALPeak;
+typedef struct _GSTLALPeakClass GSTLALPeakClass;
+
 
+/**
+ * GSTLALPeak:
+ */
 
-typedef struct {
-	
+
+struct _GSTLALPeak {
 	GstElement element;
 
 	GstPad *sinkpad;
@@ -73,8 +76,17 @@ typedef struct {
 	void *data;
 	guint64 next_output_offset;
 	GstClockTime next_output_timestamp;
+};
+
 
-} GSTLALPeak;
+/**
+ * GSTLALPeakClass:
+ */
+
+
+struct _GSTLALPeakClass {
+	GstElementClass parent_class;
+};
 
 
 GType gstlal_peak_get_type(void);

gstlal/gst/lal/gstlal_reblock.h

@@ -42,12 +42,16 @@ G_BEGIN_DECLS
 	(G_TYPE_CHECK_CLASS_TYPE((klass), GSTLAL_REBLOCK_TYPE))
 
 
-typedef struct {
-	GstElementClass parent_class;
-} GSTLALReblockClass;
+typedef struct _GSTLALReblock GSTLALReblock;
+typedef struct _GSTLALReblockClass GSTLALReblockClass;
+
 
+/**
+ * GSTLALReblock:
+ */
 
-typedef struct _GSTLALReblock {
+
+struct _GSTLALReblock {
 	GstElement element;
 
 	GstPad *sinkpad;
@@ -56,7 +60,17 @@ typedef struct _GSTLALReblock {
 	gint rate;
 	gint unit_size;
 	GstClockTime block_duration;
-} GSTLALReblock;
+};
+
+
+/**
+ * GSTLALReblockClass:
+ */
+
+
+struct _GSTLALReblockClass {
+	GstElementClass parent_class;
+};
 
 
 GType gstlal_reblock_get_type(void);

gstlal/gst/lal/gstlal_segmentsrc.h

@@ -19,11 +19,14 @@ G_BEGIN_DECLS
 #define GST_IS_GSTLAL_SEGMENTSRC_CLASS(klass) \
     (G_TYPE_CHECK_CLASS_TYPE((klass), GSTLAL_SEGMENTSRC_TYPE))
 
-typedef struct {
-    GstBaseSrcClass     parent_class;
-} GSTLALSegmentSrcClass;
+typedef struct _GSTLALSegmentSrc GSTLALSegmentSrc;
+typedef struct _GSTLALSegmentSrcClass GSTLALSegmentSrcClass;
+
+/**
+ * GSTLALSegmentSrc:
+ */
 
-typedef struct {
+struct _GSTLALSegmentSrc {
     GstBaseSrc			element;
 
     GMutex			*segment_matrix_lock;
@@ -31,8 +34,15 @@ typedef struct {
     gboolean			invert_output;
     gint			rate;
     gint			width;
+};
 
-} GSTLALSegmentSrc;
+/**
+ * GSTLALSegmentSrcClass:
+ */
+
+struct _GSTLALSegmentSrcClass {
+    GstBaseSrcClass     parent_class;
+};
 
 GType gstlal_segmentsrc_get_type(void);
 

gstlal/gst/lal/gstlal_shift.h

@@ -42,12 +42,16 @@ G_BEGIN_DECLS
 	(G_TYPE_CHECK_CLASS_TYPE((klass), GSTLAL_SHIFT_TYPE))
 
 
-typedef struct {
-	GstElementClass parent_class;
-} GSTLALShiftClass;
+typedef struct _GSTLALShift GSTLALShift;
+typedef struct _GSTLALShiftClass GSTLALShiftClass;
+
 
+/**
+ * GSTLALShift:
+ */
 
-typedef struct _GSTLALShift {
+
+struct _GSTLALShift {
 	GstElement element;
 
 	GstPad *sinkpad;
@@ -56,7 +60,17 @@ typedef struct _GSTLALShift {
 	gint rate;
 	gint unit_size;
 	gint64 shift;
-} GSTLALShift;
+};
+
+
+/**
+ * GSTLALShiftClass:
+ */
+
+
+struct _GSTLALShiftClass {
+	GstElementClass parent_class;
+};
 
 
 GType gstlal_shift_get_type(void);

gstlal/gst/lal/gstlal_simulation.h

@@ -45,12 +45,15 @@ G_BEGIN_DECLS
 	(G_TYPE_CHECK_CLASS_TYPE((klass), GSTLAL_SIMULATION_TYPE))
 
 
-typedef struct {
-	GstBaseTransformClass parent_class;
-} GSTLALSimulationClass;
+typedef struct _GSTLALSimulation GSTLALSimulation;
+typedef struct _GSTLALSimulationClass GSTLALSimulationClass;
+
+/**
+ * GSTLALSimulation:
+ */
 
 
-typedef struct {
+struct _GSTLALSimulation {
 	GstBaseTransform parent;
 
 	char *xml_location;
@@ -69,7 +72,17 @@ typedef struct {
 	char *units;
 
 	REAL8TimeSeries *simulation_series;
-} GSTLALSimulation;
+};
+
+
+/**
+ * GSTLALSimulationClass:
+ */
+
+
+struct _GSTLALSimulationClass {
+	GstBaseTransformClass parent_class;
+};
 
 
 GType gstlal_simulation_get_type(void);

gstlal/gst/lal/gstlal_statevector.h

@@ -48,12 +48,16 @@ G_BEGIN_DECLS
 	(G_TYPE_CHECK_CLASS_TYPE((klass), GSTLAL_STATEVECTOR_TYPE))
 
 
-typedef struct {
-	GstBaseTransformClass parent_class;
-} GSTLALStateVectorClass;
+typedef struct _GSTLALStateVector GSTLALStateVector;
+typedef struct _GSTLALStateVectorClass GSTLALStateVectorClass;
+
 
+/**
+ * GSTLALStateVector:
+ */
 
-typedef struct GSTLALStateVector {
+
+struct _GSTLALStateVector {
 	GstBaseTransform element;
 
 	guint required_on;
@@ -64,7 +68,17 @@ typedef struct GSTLALStateVector {
 	guint64 gap_samples;
 
 	guint (*get_input)(void **);
-} GSTLALStateVector;
+};
+
+
+/**
+ * GSTLALStateVectorClass:
+ */
+
+
+struct _GSTLALStateVectorClass {
+	GstBaseTransformClass parent_class;
+};
 
 
 GType gstlal_statevector_get_type(void);

gstlal/gst/lal/gstlal_sumsquares.h

@@ -48,14 +48,16 @@ G_BEGIN_DECLS
 	(G_TYPE_CHECK_CLASS_TYPE((klass), GSTLAL_SUMSQUARES_TYPE))
 
 
-typedef struct {
-	GstBaseTransformClass parent_class;
-} GSTLALSumSquaresClass;
+typedef struct _GSTLALSumSquares GSTLALSumSquares;
+typedef struct _GSTLALSumSquaresClass GSTLALSumSquaresClass;
+
 
+/**
+ * GSTLALSumSquares:
+ */
 
-struct GSTLALSumSquares;
 
-typedef struct GSTLALSumSquares {
+struct _GSTLALSumSquares {
 	GstBaseTransform element;
 
 	gint channels;
@@ -64,9 +66,19 @@ typedef struct GSTLALSumSquares {
 	double *weights;
 	void *weights_native;
 
-	void *(*make_weights_native_func)(struct GSTLALSumSquares *);
-	GstFlowReturn (*sumsquares_func)(struct GSTLALSumSquares *, GstBuffer *, GstBuffer *);
-} GSTLALSumSquares;
+	void *(*make_weights_native_func)(GSTLALSumSquares *);
+	GstFlowReturn (*sumsquares_func)(GSTLALSumSquares *, GstBuffer *, GstBuffer *);
+};
+
+
+/**
+ * GSTLALSumSquaresClass:
+ */
+
+
+struct _GSTLALSumSquaresClass {
+	GstBaseTransformClass parent_class;
+};
 
 
 GType gstlal_sumsquares_get_type(void);

gstlal/gst/lal/gstlal_togglecomplex.h

@@ -48,14 +48,28 @@ G_BEGIN_DECLS
 	(G_TYPE_CHECK_CLASS_TYPE((klass), GSTLAL_TOGGLECOMPLEX_TYPE))
 
 
-typedef struct {
-	GstBaseTransformClass parent_class;
-} GSTLALToggleComplexClass;
+typedef struct _GSTLALToggleComplex GSTLALToggleComplex;
+typedef struct _GSTLALToggleComplexClass GSTLALToggleComplexClass;
+
 
+/**
+ * GSTLALToggleComplex:
+ */
 
-typedef struct {
+
+struct _GSTLALToggleComplex {
 	GstBaseTransform element;
-} GSTLALToggleComplex;
+};
+
+
+/**
+ * GSTLALToggleComplexClass:
+ */
+
+
+struct _GSTLALToggleComplexClass {
+	GstBaseTransformClass parent_class;
+};
 
 
 GType gstlal_togglecomplex_get_type(void);

gstlal/gst/lal/gstlal_whiten.h

@@ -71,12 +71,16 @@ GType gstlal_psdmode_get_type(void);
 	(G_TYPE_CHECK_CLASS_TYPE((klass), GSTLAL_WHITEN_TYPE))
 
 
-typedef struct {
-	GstBaseTransformClass parent_class;
-} GSTLALWhitenClass;
+typedef struct _GSTLALWhiten GSTLALWhiten;
+typedef struct _GSTLALWhitenClass GSTLALWhitenClass;
+
+
+/**
+ * GSTLALWhiten:
+ */
 
 
-typedef struct {
+struct _GSTLALWhiten {
 	GstBaseTransform element;
 
 	/*
@@ -138,7 +142,17 @@ typedef struct {
 
 	LALPSDRegressor *psd_regressor;
 	REAL8FrequencySeries *psd;
-} GSTLALWhiten;
+};
+
+
+/**
+ * GSTLALWhitenClass:
+ */
+
+
+struct _GSTLALWhitenClass {
+	GstBaseTransformClass parent_class;
+};
 
 
 GType gstlal_whiten_get_type(void);