Skip to content
This repository was archived by the owner on May 3, 2026. It is now read-only.

Commit bfbda47

Browse files
committed
clarify AdiPort docs
1 parent 910401e commit bfbda47

1 file changed

Lines changed: 3 additions & 6 deletions

File tree

include/pros/devices/port.hpp

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -54,11 +54,11 @@ class SmartPort {
5454
*/
5555
class AdiPort {
5656
// AdiPort instances can only be constructed by the AdiExpander class
57-
friend AdiExpander;
57+
friend class AdiExpander;
5858

5959
public:
6060
/**
61-
* @brief Get the ADI Port as an uppercase letter
61+
* @brief Get the ADI Port as an uppercase letter ('A' to 'H')
6262
*
6363
* @return constexpr char
6464
*/
@@ -67,17 +67,14 @@ class AdiPort {
6767
}
6868

6969
/**
70-
* @brief Get the ADI Port as an index
70+
* @brief Get the ADI Port as a 0-indexed number (0-7)
7171
*
7272
* @return constexpr uint8_t
7373
*/
7474
constexpr uint8_t as_index() const {
7575
return m_letter - 'A';
7676
}
7777

78-
// users should always use a reference to an AdiPort
79-
AdiPort(AdiPort& other) = delete;
80-
8178
SmartPort host_port;
8279

8380
private:

0 commit comments

Comments
 (0)