Fossil SCM

Improvements to comments in graph.c. No changes to actual code.

drh 2024-04-21 18:46 trunk

Commit 40320f6584d652585e1261a980e06136d9dc2644f28e928e2ea39ab21e1dc112

Parent 5f47bb59a7846ae…

1 file changed +8 -2

M src/graph.c

+8 -2

		--- src/graph.c
		+++ src/graph.c
		@@ -24,22 +24,28 @@
24	24	/* Notes:
25	25	**
26	26	** The graph is laid out in 1 or more "rails". A "rail" is a vertical
27	27	** band in the graph in which one can place nodes or arrows connecting
28	28	** nodes. There can be between 1 and GR_MAX_RAIL rails. If the graph
29		-** is to complex to be displayed in GR_MAX_RAIL rails, it is omitted.
	29	+** is too complex to be displayed in GR_MAX_RAIL rails, it is omitted.
30	30	**
31	31	** A "riser" is the thick line that comes out of the top of a node and
32	32	** goes up to the next node on the branch, or to the top of the screen.
33	33	** A "descender" is a thick line that comes out of the bottom of a node
34	34	** and proceeds down to the bottom of the page.
	35	+**
	36	+** A "merge riser" is a thin line going up out of a node to indicate a
	37	+** merge or cherrypick. (Cherrypicks are drawn with thin dashed lines.
	38	+** Merges are drawn with thin solid lines.) A "merge riser" might go
	39	+** stright up out of the top of a leaf node, but for non-leaves, they
	40	+** go horizontally to their assigned rail first, then up.
35	41	**
36	42	** Invoke graph_init() to create a new GraphContext object. Then
37	43	** call graph_add_row() to add nodes, one by one, to the graph.
38	44	** Nodes must be added in display order, from top to bottom.
39	45	** Then invoke graph_render() to run the layout algorithm. The
40		-** layout algorithm computes which rails all of the nodes sit on, and
	46	+** layout algorithm computes which rail each nodes sit on, and
41	47	** the rails used for merge arrows.
42	48	*/
43	49
44	50	#if INTERFACE
45	51
46	52

	--- src/graph.c
	+++ src/graph.c
	@@ -24,22 +24,28 @@
24	/* Notes:
25	**
26	** The graph is laid out in 1 or more "rails". A "rail" is a vertical
27	** band in the graph in which one can place nodes or arrows connecting
28	** nodes. There can be between 1 and GR_MAX_RAIL rails. If the graph
29	** is to complex to be displayed in GR_MAX_RAIL rails, it is omitted.
30	**
31	** A "riser" is the thick line that comes out of the top of a node and
32	** goes up to the next node on the branch, or to the top of the screen.
33	** A "descender" is a thick line that comes out of the bottom of a node
34	** and proceeds down to the bottom of the page.






35	**
36	** Invoke graph_init() to create a new GraphContext object. Then
37	** call graph_add_row() to add nodes, one by one, to the graph.
38	** Nodes must be added in display order, from top to bottom.
39	** Then invoke graph_render() to run the layout algorithm. The
40	** layout algorithm computes which rails all of the nodes sit on, and
41	** the rails used for merge arrows.
42	*/
43
44	#if INTERFACE
45
46

	--- src/graph.c
	+++ src/graph.c
	@@ -24,22 +24,28 @@
24	/* Notes:
25	**
26	** The graph is laid out in 1 or more "rails". A "rail" is a vertical
27	** band in the graph in which one can place nodes or arrows connecting
28	** nodes. There can be between 1 and GR_MAX_RAIL rails. If the graph
29	** is too complex to be displayed in GR_MAX_RAIL rails, it is omitted.
30	**
31	** A "riser" is the thick line that comes out of the top of a node and
32	** goes up to the next node on the branch, or to the top of the screen.
33	** A "descender" is a thick line that comes out of the bottom of a node
34	** and proceeds down to the bottom of the page.
35	**
36	** A "merge riser" is a thin line going up out of a node to indicate a
37	** merge or cherrypick. (Cherrypicks are drawn with thin dashed lines.
38	** Merges are drawn with thin solid lines.) A "merge riser" might go
39	** stright up out of the top of a leaf node, but for non-leaves, they
40	** go horizontally to their assigned rail first, then up.
41	**
42	** Invoke graph_init() to create a new GraphContext object. Then
43	** call graph_add_row() to add nodes, one by one, to the graph.
44	** Nodes must be added in display order, from top to bottom.
45	** Then invoke graph_render() to run the layout algorithm. The
46	** layout algorithm computes which rail each nodes sit on, and
47	** the rails used for merge arrows.
48	*/
49
50	#if INTERFACE
51
52

Fossil SCM

Keyboard Shortcuts