mhu/gds-render
1
0
Fork 0
Code Issues 4 Pull Requests Actions Releases 8 Wiki Activity

Fixup round for doxygen

Browse Source
This commit is contained in:
Mario Hüttel
2019-09-28 22:57:31 +02:00
parent e703d4427a
commit 7cbde0f30a
11 changed files with 41 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doxygen/external-renderer.dox
View File

@@ -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:
*

4
doxygen/gds-output-renderer.dox
View File

@@ -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)

2
doxygen/latex-renderer.dox
View File

@@ -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:
*

36
doxygen/usage.dox
View File

@@ -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
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
Help 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
@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.