This repository was archived by the owner on Jun 18, 2026. It is now read-only.
Commit 322beb3
gardener
docs(Edge): replace stub Javadoc with full class-and-method documentation
Edge.java was the original boilerplate from the NetBeans template:
- file header "To change this template, choose Tools | Templates"
- class-level Javadoc with "@author user"
- no documentation at all for the no-arg constructor's intended use
- no documentation for the (type, v1, v2) constructor's argument order
(recently the source of a real bug in GraphComplementAnalyzer)
- no documentation for setWeight/getWeight/setLabel/getLabel
This commit:
- Adds a proper class-level Javadoc explaining the edge model: type codes
(with the canonical f/fs/c/s/sg list), the undirected equality
semantics, the weight/label fields, and the optional temporal extent.
- Calls out that vertex1/vertex2 are advisory and that analyzers should
prefer Graph.getEndpoints(e) for the authoritative endpoints.
- Documents the no-arg constructor as framework-only.
- Documents the 3-arg constructor and explicitly warns about argument
order (the bug fixed in 33518cc happened because callers had swapped
the type and vertex arguments without compiler help).
- Documents the four trivial accessors so external users / IDE tooltips
no longer see naked Javadoc-less methods.
No behavior change. Existing Edge and GraphComplement tests still pass.1 parent 33518cc commit 322beb3
1 file changed
Lines changed: 71 additions & 8 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | | - | |
3 | | - | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
4 | 5 | | |
5 | 6 | | |
6 | 7 | | |
| 8 | + | |
7 | 9 | | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
8 | 38 | | |
9 | | - | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
10 | 44 | | |
11 | 45 | | |
12 | 46 | | |
| |||
44 | 78 | | |
45 | 79 | | |
46 | 80 | | |
47 | | - | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
48 | 85 | | |
49 | 86 | | |
50 | 87 | | |
51 | 88 | | |
52 | 89 | | |
53 | 90 | | |
54 | | - | |
55 | | - | |
56 | | - | |
57 | | - | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
58 | 103 | | |
59 | 104 | | |
60 | 105 | | |
| |||
63 | 108 | | |
64 | 109 | | |
65 | 110 | | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
66 | 116 | | |
67 | 117 | | |
68 | 118 | | |
69 | 119 | | |
70 | 120 | | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
71 | 125 | | |
72 | 126 | | |
73 | 127 | | |
74 | 128 | | |
75 | 129 | | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
76 | 135 | | |
77 | 136 | | |
78 | 137 | | |
79 | 138 | | |
80 | 139 | | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
81 | 144 | | |
82 | 145 | | |
83 | 146 | | |
| |||
0 commit comments