Fixup round for doxygen
This commit is contained in:
parent
e703d4427a
commit
7cbde0f30a
@ -2,7 +2,7 @@
|
||||
* @defgroup ExternalRenderer External Shared Object Renderer
|
||||
* @ingroup GdsOutputRenderer
|
||||
*
|
||||
* @subsection ExternalRendererProps Properties
|
||||
* @section ExternalRendererProps Properties
|
||||
* This class inherits all properties from its parent @ref GdsOutputRenderer.
|
||||
* In addition to that, it implements the following properties:
|
||||
*
|
||||
|
||||
@ -15,7 +15,7 @@
|
||||
*
|
||||
* By default this class implements the following features:
|
||||
*
|
||||
* @subsection GdsOutputRendererProps Properties
|
||||
* @section GdsOutputRendererProps Properties
|
||||
* Property Name | Description
|
||||
* -----------------|----------------------------------------------------------------
|
||||
* layer-settings | LayerSettings object containing the layer rendering information
|
||||
@ -23,7 +23,7 @@
|
||||
*
|
||||
* All these properties have to be set for rendering.
|
||||
*
|
||||
* @subsection GdsOutputRendererSignals Signals / Events
|
||||
* @section GdsOutputRendererSignals Signals / Events
|
||||
* Signal Name | Description | Callback prototype
|
||||
* -----------------|-------------------------------------------------|-----------------------------------------------------------
|
||||
* async-finished | The asynchronous rendering is finished | void callback(GdsOutputRenderer *src, gpointer user_data)
|
||||
|
||||
@ -4,7 +4,7 @@
|
||||
*
|
||||
* This is the class implementing the \f$\mbox{\LaTeX}\f$ / TikZ output rendering
|
||||
|
||||
* @subsection LaTeXRendererProps Properties
|
||||
* @section LaTeXRendererProps Properties
|
||||
* This class inherits all properties from its parent @ref GdsOutputRenderer.
|
||||
* In addition to that, it implements the following properties:
|
||||
*
|
||||
|
||||
@ -4,24 +4,24 @@
|
||||
To use the application on the command line check 'gds-render `--`help'.
|
||||
|
||||
Usage:
|
||||
gds-render [OPTION…] FILE - Convert GDS file <FILE> to graphic
|
||||
gds-render [OPTION…] FILE - Convert GDS file `<FILE>` to graphic
|
||||
|
||||
Help Options:
|
||||
-h, '--'help Show help options
|
||||
'--'help-all Show all help options
|
||||
'--'help-gtk Show GTK+ Options
|
||||
-h, `--`help Show help options
|
||||
`--`help-all Show all help options
|
||||
`--`help-gtk Show GTK+ Options
|
||||
|
||||
Application Options:
|
||||
-v, '--'version Print version
|
||||
-r, '--'renderer=pdf|svg|tikz|ext Renderer to use
|
||||
-s, '--'scale=<SCALE> Divide output coordinates by <SCALE>
|
||||
-o, '--'output-file=PATH Output file path
|
||||
-m, '--'mapping=PATH Path for Layer Mapping File
|
||||
-c, '--'cell=NAME Cell to render
|
||||
-a, '--'tex-standalone Create standalone PDF
|
||||
-l, '--'tex-layers Create PDF Layers (OCG)
|
||||
-P, '--'custom-render-lib=PATH Path to a custom shared object, that implements the render_cell_to_file function
|
||||
'--'display=DISPLAY X display to use
|
||||
-v, `--`version Print version
|
||||
-r, `--`renderer=pdf|svg|tikz|ext Renderer to use
|
||||
-s, `--`scale=`<SCALE>` Divide output coordinates by `<SCALE>`
|
||||
-o, `--`output-file=PATH Output file path
|
||||
-m, `--`mapping=PATH Path for Layer Mapping File
|
||||
-c, `--`cell=NAME Cell to render
|
||||
-a, `--`tex-standalone Create standalone PDF
|
||||
-l, `--`tex-layers Create PDF Layers (OCG)
|
||||
-P, `--`custom-render-lib=PATH Path to a custom shared object, that implements the render_cell_to_file function
|
||||
`--`display=DISPLAY X display to use
|
||||
|
||||
|
||||
@section gui Graphical User Interface
|
||||
@ -33,7 +33,7 @@ It is possible to export the layer configurations so they can be used later on.
|
||||
@image html gui.png
|
||||
@image latex gui.png
|
||||
|
||||
The cell selector on the left shows the GDS Libraries and Cells. The cells are marked green if all references inside the cell could be found. If not all references could be found, the cell is marked orange. This doens't show if child cells have missing childs. Only one level of the hierarchy is checked in order to make it easier to spot an errorneous cell. Cells with missing child cells are still renderable but '--' obviously '--' faulty. If a cell or any sub-cell contains a reference loop, the cell is marked red. In this case it can't be selected for rendering.
|
||||
The cell selector on the left shows the GDS Libraries and Cells. The cells are marked green if all references inside the cell could be found. If not all references could be found, the cell is marked orange. This doens't show if child cells have missing childs. Only one level of the hierarchy is checked in order to make it easier to spot an errorneous cell. Cells with missing child cells are still renderable but `--` obviously `--` faulty. If a cell or any sub-cell contains a reference loop, the cell is marked red. In this case it can't be selected for rendering.
|
||||
|
||||
In the above image the cell is green; so everything is okay.
|
||||
|
||||
|
||||
@ -42,7 +42,7 @@
|
||||
* @param layer_file Layer mapping file
|
||||
* @param so_path Shared object
|
||||
* @param tex_standalone Standalone TeX
|
||||
* @param tec_layers TeX OCR layers
|
||||
* @param tex_layers TeX OCR layers
|
||||
* @param scale Scale value
|
||||
* @return Error code, 0 if successful
|
||||
*/
|
||||
|
||||
@ -18,8 +18,8 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file layer-info.h
|
||||
* @brief LayerSettings class heade file
|
||||
* @file layer-settings.h
|
||||
* @brief LayerSettings class header file
|
||||
* @author Mario Hüttel <mario.huettel@gmx.net>
|
||||
*/
|
||||
|
||||
@ -96,8 +96,12 @@ int layer_settings_remove_layer(LayerSettings *settings, int layer);
|
||||
GList *layer_settings_get_layer_info_list(LayerSettings *settings);
|
||||
|
||||
/**
|
||||
* @brief Write layer settings to a CSV file
|
||||
* @param path
|
||||
* @brief Write layer settings to a CSV file.
|
||||
*
|
||||
* This function writes the layer settings to a CSV file according to the
|
||||
* layer mapping specification (@ref lmf-spec)
|
||||
* @param settings LayerSettings object
|
||||
* @param path Output path for CSV file.
|
||||
* @return 0 if successful
|
||||
*/
|
||||
int layer_settings_to_csv(LayerSettings *settings, const char *path);
|
||||
|
||||
@ -17,7 +17,7 @@
|
||||
* along with GDSII-Converter. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
/**
|
||||
* @file cairo-output.h
|
||||
* @file cairo-renderer.h
|
||||
* @brief Header File for Cairo output renderer
|
||||
* @author Mario Hüttel <mario.huettel@gmx.net>
|
||||
*/
|
||||
|
||||
@ -18,7 +18,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file latex-output.h
|
||||
* @file latex-renderer.h
|
||||
* @brief LaTeX output renderer
|
||||
* @author Mario Hüttel <mario.huettel@gmx.net>
|
||||
*/
|
||||
|
||||
@ -18,7 +18,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file layer-info.c
|
||||
* @file layer-settings.c
|
||||
* @brief Implementation of the LayerSettings class
|
||||
* @author Mario Hüttel <mario.huettel@gmx.net>
|
||||
*/
|
||||
|
||||
@ -17,7 +17,7 @@
|
||||
* along with GDSII-Converter. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
/**
|
||||
* @file cairo-output.c
|
||||
* @file cairo-renderer.c
|
||||
* @brief Output renderer for Cairo PDF export
|
||||
* @author Mario Hüttel <mario.huettel@gmx.net>
|
||||
*/
|
||||
|
||||
@ -18,7 +18,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file latex-output.c
|
||||
* @file latex-renderer.c
|
||||
* @brief LaTeX Output Renderer
|
||||
* @author Mario Hüttel <mario.huettel@gmx.net>
|
||||
*/
|
||||
|
||||
Loading…
Reference in New Issue
Block a user