Improve doxygen documentation
This commit is contained in:
4
doxygen/cairo-renderer.dox
Normal file
4
doxygen/cairo-renderer.dox
Normal file
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
* @defgroup Cairo-Renderer Cairo Renderer
|
||||
* @ingroup renderers
|
||||
*/
|
3
doxygen/command-line.dox
Normal file
3
doxygen/command-line.dox
Normal file
@@ -0,0 +1,3 @@
|
||||
/**
|
||||
* @defgroup cmdline Command Line Interface
|
||||
*/
|
4
doxygen/external-renderer.dox
Normal file
4
doxygen/external-renderer.dox
Normal file
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
* @defgroup external-renderer External Shared Object Renderer
|
||||
* @ingroup renderers
|
||||
*/
|
@@ -2,5 +2,4 @@
|
||||
|
||||
/**
|
||||
* @defgroup GUI Graphical User Interface
|
||||
* @ingroup MainApplication
|
||||
*/
|
||||
|
4
doxygen/latex-renderer.dox
Normal file
4
doxygen/latex-renderer.dox
Normal file
@@ -0,0 +1,4 @@
|
||||
/**
|
||||
* @defgroup LaTeX-Renderer LaTeX/TikZ Renderer
|
||||
* @ingroup renderers
|
||||
*/
|
7
doxygen/layer-selector.dox
Normal file
7
doxygen/layer-selector.dox
Normal file
@@ -0,0 +1,7 @@
|
||||
/**
|
||||
* @defgroup layer-selector LayerSelector Object
|
||||
* @ingroup GUI
|
||||
*
|
||||
* This objects implements the layer selector and displays the layers in a list box.
|
||||
* It uses @ref LayerElement objects to display the individual layers inside the list box.
|
||||
*/
|
18
doxygen/lib-cell-renderer.dox
Normal file
18
doxygen/lib-cell-renderer.dox
Normal file
@@ -0,0 +1,18 @@
|
||||
/**
|
||||
* @defgroup LibCellRenderer LibCellRenderer GObject
|
||||
* @ingroup GUI
|
||||
*
|
||||
* The LibCellRenderer Object is used to render @ref gds_cell and @ref gds_library elements
|
||||
* to a GtkTreeView.
|
||||
*
|
||||
* The LibCellRenderer class is derived from a GtkCellRendererText and works the same way.
|
||||
* The additinal features are three new properties:
|
||||
*
|
||||
* - *gds-lib*: This property can be used to set a @ref gds_library structure. The renderer will render the name of the library.
|
||||
* - *gds-cell*: This property can be used to set a @ref gds_cell structure. The renderer will render the name of the cell.
|
||||
* - *error-level*: Set the error level of the cell/library. This affects the foreground color of hte rendered output.
|
||||
*
|
||||
* Internally the class operates by setting the 'text' property, which is inherited form the base class to the library/cell name (gds_library::name and gds_cell::name fields).
|
||||
* The error level (@ref LIB_CELL_RENDERER_ERROR_WARN and @ref LIB_CELL_RENDERER_ERROR_ERR) is translated to the inherited 'foreground-rgba' property.
|
||||
*
|
||||
*/
|
@@ -1,6 +0,0 @@
|
||||
/* This file only contains help information for doxygen */
|
||||
|
||||
/**
|
||||
* @defgroup MainApplication Main Application
|
||||
*
|
||||
*/
|
9
doxygen/renderers.dox
Normal file
9
doxygen/renderers.dox
Normal file
@@ -0,0 +1,9 @@
|
||||
/**
|
||||
* @defgroup renderers Output Renderers
|
||||
*
|
||||
* The renderers are used to convert the cell structures read from the GDS layout file
|
||||
* into different output formats.
|
||||
*
|
||||
* Currently the renders are statically implemented without the use of GObjects.
|
||||
* This will probably change in future releases in order to make it easier to integrate new rendering methods.
|
||||
*/
|
Reference in New Issue
Block a user