Improve doxygen documentation
This commit is contained in:
@@ -24,7 +24,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @addtogroup MainApplication
|
||||
* @addtogroup cmdline
|
||||
* @{
|
||||
*/
|
||||
|
||||
|
@@ -24,7 +24,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @addtogroup MainApplication
|
||||
* @addtogroup external-renderer
|
||||
* @{
|
||||
*/
|
||||
|
||||
|
@@ -27,7 +27,7 @@
|
||||
#define _GDS_RENDER_GUI_
|
||||
|
||||
/**
|
||||
* @addtogroup MainApplication
|
||||
* @addtogroup GUI
|
||||
* @{
|
||||
*/
|
||||
|
||||
|
@@ -18,7 +18,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file layer-info.c
|
||||
* @file layer-info.h
|
||||
* @brief Helper functions and definition of layer info struct
|
||||
* @author Mario Hüttel <mario.huettel@gmx.net>
|
||||
*/
|
||||
|
@@ -23,6 +23,11 @@
|
||||
* @author Mario Hüttel <mario.huettel@gmx.net>
|
||||
*/
|
||||
|
||||
/**
|
||||
* @addtogroup layer-selector
|
||||
* @{
|
||||
*/
|
||||
|
||||
#ifndef __LAYER_SELECTOR_H__
|
||||
#define __LAYER_SELECTOR_H__
|
||||
|
||||
@@ -88,3 +93,5 @@ void layer_selector_force_sort(LayerSelector *selector, enum layer_selector_sort
|
||||
G_END_DECLS
|
||||
|
||||
#endif /* __LAYER_SELECTOR_H__ */
|
||||
|
||||
/** @} */
|
||||
|
@@ -27,7 +27,7 @@
|
||||
#define __MAPPING_PARSER_H__
|
||||
|
||||
/**
|
||||
* @addtogroup MainApplication
|
||||
* @addtogroup Mapping-Parser
|
||||
* @{
|
||||
*/
|
||||
|
||||
|
@@ -17,6 +17,17 @@
|
||||
* along with GDSII-Converter. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file lib-cell-renderer.h
|
||||
* @brief Header file for the LibCellRenderer GObject Class
|
||||
* @author Mario Hüttel <mario.huettel@gmx.net>
|
||||
*/
|
||||
|
||||
/**
|
||||
* @addtogroup LibCellRenderer
|
||||
* @{
|
||||
*/
|
||||
|
||||
#ifndef __LIB_CELL_RENDERER_H__
|
||||
#define __LIB_CELL_RENDERER_H__
|
||||
|
||||
@@ -27,8 +38,12 @@ G_BEGIN_DECLS
|
||||
G_DECLARE_FINAL_TYPE(LibCellRenderer, lib_cell_renderer, LIB_CELL, RENDERER, GtkCellRendererText)
|
||||
#define TYPE_LIB_CELL_RENDERER (lib_cell_renderer_get_type())
|
||||
|
||||
/** @{
|
||||
* Error levels
|
||||
*/
|
||||
#define LIB_CELL_RENDERER_ERROR_WARN (1U<<0)
|
||||
#define LIB_CELL_RENDERER_ERROR_ERR (1U<<1)
|
||||
/** @} */
|
||||
|
||||
typedef struct _LibCellRenderer {
|
||||
/* Inheritance */
|
||||
@@ -36,9 +51,20 @@ typedef struct _LibCellRenderer {
|
||||
/* Custom Elements */
|
||||
} LibCellRenderer;
|
||||
|
||||
/**
|
||||
* @brief lib_cell_renderer_get_type
|
||||
* @return GObject Type
|
||||
*/
|
||||
GType lib_cell_renderer_get_type(void);
|
||||
|
||||
/**
|
||||
* @brief Create a new renderer for renderering @ref gds_cell and @ref gds_library elements.
|
||||
* @return New renderer object
|
||||
*/
|
||||
GtkCellRenderer *lib_cell_renderer_new(void);
|
||||
|
||||
G_END_DECLS
|
||||
|
||||
#endif /* __LIB_CELL_RENDERER_H__ */
|
||||
|
||||
/** @} */
|
||||
|
@@ -24,7 +24,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @addtogroup MainApplication
|
||||
* @addtogroup GUI
|
||||
* @{
|
||||
*/
|
||||
|
||||
|
@@ -18,11 +18,11 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @addtogroup MainApplication
|
||||
* @addtogroup version
|
||||
* @{
|
||||
*/
|
||||
|
||||
/** @brief This string holds the 'git describe' version of the app */
|
||||
extern char *_app_version_string;
|
||||
extern const char *_app_version_string;
|
||||
|
||||
/** @} */
|
||||
|
Reference in New Issue
Block a user