diff options
| author | David Robillard <d@drobilla.net> | 2022-06-29 21:54:44 -0400 |
|---|---|---|
| committer | David Robillard <d@drobilla.net> | 2022-07-20 16:39:08 -0400 |
| commit | 4215e7defa0c7ebbea18fc80257d53f6d6f7443e (patch) | |
| tree | 72fe07d7493785026d851bb57ffa2a154bd80777 | |
| parent | 17f58b94abf5e7b1ad7ea3c40d0cd1107298d41a (diff) | |
| download | ganv-4215e7defa0c7ebbea18fc80257d53f6d6f7443e.tar.gz ganv-4215e7defa0c7ebbea18fc80257d53f6d6f7443e.tar.bz2 ganv-4215e7defa0c7ebbea18fc80257d53f6d6f7443e.zip | |
Add missing documentation
| -rw-r--r-- | ganv/canvas.h | 16 |
1 files changed, 12 insertions, 4 deletions
diff --git a/ganv/canvas.h b/ganv/canvas.h index 089bb1d..ca50b21 100644 --- a/ganv/canvas.h +++ b/ganv/canvas.h @@ -92,7 +92,15 @@ typedef void (*GanvEdgeFunc)(GanvEdge* edge, void* data); */ typedef void (*GanvNodeFunc)(GanvNode* node, void* data); -typedef int (*GanvPortOrderFunc)(const GanvPort*, const GanvPort*, void* data); +/** + * GanvPortOrderFunc: + * @lhs: Left-hand port to compare. + * @rhs: Right-hand port to compare. + * @data: User callback data. + * + * A function to compare two ports. + */ +typedef int (*GanvPortOrderFunc)(const GanvPort* lhs, const GanvPort* rhs, void* data); /** * ganv_canvas_new: @@ -621,9 +629,9 @@ ganv_canvas_move_contents_to(GanvCanvas* canvas, double x, double y); /** * ganv_canvas_set_port_order: - * @canvas The canvas to set the default port order on. - * @port_cmp Port comparison function. - * @data Data to be passed to order. + * @canvas: The canvas to set the default port order on. + * @port_cmp: (scope call): Port comparison function. + * @data: Data to be passed to order. * * Set a comparator function to use as the default order for ports on modules. * If left unset, ports are shown in the order they are added. |