Skip to content

Commit 57120a3

Browse files
committed
Clarified comments
1 parent 0e78da5 commit 57120a3

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

TestInterface.h

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,8 @@ class TestInterface
6161
/**
6262
@brief Gets the manufacturer-assigned serial number for this programming adapter, if any.
6363
64+
This is a persistent, read-only string assigned by the manufacturer to identify this adapter.
65+
6466
Derived classes may choose to return the user ID, an empty string, or another default value if no serial number
6567
has been assigned.
6668
@@ -69,7 +71,9 @@ class TestInterface
6971
virtual std::string GetSerial() =0;
7072

7173
/**
72-
@brief Gets the user-assigned name for this JTAG adapter, if any.
74+
@brief Gets the user-assigned name for this programming adapter, if any.
75+
76+
This is a persistent, user-writeable string ("hostname") used to identify this adapter.
7377
7478
Derived classes may choose to return the serial number, an empty string, or another default value if no name
7579
has been assigned.

0 commit comments

Comments
 (0)