Doxygen documentation

widgets/conv-settings-dialog.c

@@ -17,6 +17,17 @@
  * along with GDSII-Converter.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @file conv-settings-dilaog.c
+ * @brief Implementation of the setting dialog
+ * @author Mario Hüttel <mario.huettel@gmx.net>
+ */
+
+/**
+ * @addtogroup Widgets
+ * @{
+ */
+
 #include "conv-settings-dialog.h"
 
 struct  _RendererSettingsDialog {
@@ -126,3 +137,5 @@ void renderer_settings_dialog_set_settings(RendererSettingsDialog *dialog, struc
 		break;
 	}
 }
+
+/** @} */

widgets/conv-settings-dialog.h

@@ -17,6 +17,17 @@
  * along with GDSII-Converter.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @file conv-settings-dialog.h
+ * @brief Header file for the Conversion Settings Dialog
+ * @author Mario.Huettel@gmx.net <mario.huettel@gmx.net>
+ */
+
+/**
+ * @addtogroup Widgets
+ * @{
+ */
+
 #ifndef __CONV_SETTINGS_DIALOG_H__
 #define __CONV_SETTINGS_DIALOG_H__
 
@@ -24,25 +35,46 @@
 
 G_BEGIN_DECLS
 
+/** @brief return type of the RedererSettingsDialog */
 enum output_renderer {RENDERER_LATEX_TIKZ, RENDERER_CAIROGRAPHICS};
 
 G_DECLARE_FINAL_TYPE(RendererSettingsDialog, renderer_settings_dialog, RENDERER, SETTINGS_DIALOG, GtkDialog)
 
+/**
+ * @brief Create a new RedererSettingsDialog GObject
+ * @param parent Parent window
+ * @return Created dialog object
+ */
 RendererSettingsDialog *renderer_settings_dialog_new(GtkWindow *parent);
 
 #define RENDERER_TYPE_SETTINGS_DIALOG (renderer_settings_dialog_get_type())
 
+/**
+ * @brief This struct holds the renderer configuration
+ */
 struct render_settings {
-	double scale;
-	enum output_renderer renderer;
-	gboolean tex_pdf_layers;
-	gboolean tex_standalone;
+	double scale; /**< @brief Scale image down by this factor. @note Used to keep image in bound of maximum coordinate limit */
+	enum output_renderer renderer; /**< The renderer to use */
+	gboolean tex_pdf_layers; /**< Create OCG layers when rendering with TikZ */
+	gboolean tex_standalone; /**< Create a standalone compile TeX file */
 };
 
 G_END_DECLS
 
-
+/**
+ * @brief Apply settings to dialog
+ * @param dialog
+ * @param settings
+ */
 void renderer_settings_dialog_set_settings(RendererSettingsDialog *dialog, struct render_settings *settings);
+
+/**
+ * @brief Get the settings configured in the dialog
+ * @param dialog
+ * @param settings
+ */
 void renderer_settings_dialog_get_settings(RendererSettingsDialog *dialog, struct render_settings *settings);
 
 #endif /* __CONV_SETTINGS_DIALOG_H__ */
+
+/** @} */

widgets/layer-element.c

@@ -17,6 +17,17 @@
  * along with GDSII-Converter.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @file layer-element.c
+ * @brief Omplementation of the layer element used for configuring layer colors etc.
+ * @author Mario Hüttel <mario.huettel@gmx.net>
+ */
+
+/**
+ * @addtogroup Widgets
+ * @{
+ */
+
 #include "layer-element.h"
 
 G_DEFINE_TYPE(LayerElement, layer_element, GTK_TYPE_LIST_BOX_ROW)
@@ -187,3 +198,5 @@ void layer_element_set_color(LayerElement *elem, GdkRGBA *rgba)
 {
 	gtk_color_chooser_set_rgba(GTK_COLOR_CHOOSER(elem->priv.color), rgba);
 }
+
+/** @} */

widgets/layer-element.h

@@ -17,6 +17,17 @@
  * along with GDSII-Converter.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @file layer-element.h
+ * @brief Omplementation of the layer element used for configuring layer colors etc.
+ * @author Mario Hüttel <mario.huettel@gmx.net>
+ */
+
+/**
+ * @addtogroup Widgets
+ * @{
+ */
+
 #ifndef __LAYER_ELEMENT_H__
 #define __LAYER_ELEMENT_H__
 
@@ -45,17 +56,70 @@ struct _LayerElement {
 	LayerElementPriv priv;
 };
 
+/**
+ * @brief Create new layer element object
+ * @return new object
+ */
 GtkWidget *layer_element_new(void);
 
+/**
+ * @brief get name of the layer
+ * @param elem Layer element
+ * @return Name. Must not be changed, freed or anything else.
+ */
 const char *layer_element_get_name(LayerElement *elem);
+
+/**
+ * @brief layer_element_set_name
+ * @param elem set the name of the layer
+ * @param name Name. Can be freed after call to this function
+ */
 void layer_element_set_name(LayerElement *elem, const char* name);
+
+/**
+ * @brief Set layer number for this layer
+ * @param elem Layer element
+ * @param layer Layer number
+ */
 void layer_element_set_layer(LayerElement *elem, int layer);
+
+/**
+ * @brief Get layer number
+ * @param elem Layer Element
+ * @return Number of this layer
+ */
 int layer_element_get_layer(LayerElement *elem);
+
+/**
+ * @brief Set export flag for this layer
+ * @param elem Layer Element
+ * @param export flag
+ */
 void layer_element_set_export(LayerElement *elem, gboolean export);
+
+/**
+ * @brief Get export flag of layer
+ * @param elem Layer Element
+ * @return
+ */
 gboolean layer_element_get_export(LayerElement *elem);
+
+/**
+ * @brief Get color of layer
+ * @param elem Layer Element
+ * @param rgba RGBA color
+ */
 void layer_element_get_color(LayerElement *elem, GdkRGBA *rgba);
+
+/**
+ * @brief Set color of layer
+ * @param elem Layer Element
+ * @param rgba RGBA color
+ */
 void layer_element_set_color(LayerElement *elem, GdkRGBA *rgba);
 
 G_END_DECLS
 
 #endif /* __LAYER_ELEMENT_H__ */
+
+/** @} */