Skip to content

Commit ed6072b

Browse files
committed
doc(resistor): add docstrings
1 parent a1c3ff8 commit ed6072b

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

src/resistor-element.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,15 @@ const bandColors: { [key: number]: string } = {
1515
9: 'white',
1616
};
1717

18+
/**
19+
* Renders an axial-lead resistor with 4 color bands.
20+
*/
1821
@customElement('wokwi-resistor')
1922
export class ResistorElement extends LitElement {
23+
/**
24+
* Resitance value, in ohms. The value is reflected in the color of the bands, according to
25+
* standard [electronic color code](https://en.wikipedia.org/wiki/Electronic_color_code#Resistors).
26+
*/
2027
@property() value = '1000';
2128

2229
private breakValue(value: number) {

0 commit comments

Comments
 (0)