wifi: Correct typos and improve doxy (part 1)
Logging system outputs have not been modified (to avoid breaking any parsing scripts), except for a typo in InterferenceHelper
.
Here are the list of modifications:
- Finish completing doxy
- Add description of parameters
- Add units (also in attribute description)
- Capitalize or camel case when necessary
- Correct indentation
- Remove redundant doxy descriptions for overloaded/implemented methods (already in base class)
- Move doxy to .h for operator overloads
- Use full word instead of abbreviation (e.g. pkt -> packet)
- Fix a couple of typos
As per Stefano's comment, the standard uses different naming conventions for acknowledgment. Here are a few:
-
Ack
/BlockAck
/BlockAckRequest
, when it comes to the actual frames and frame variants -
Ack Policy
/Normal Ack
/Block Ack
/Block Ack Request
/No Ack
, when it comes to fields and subfields -
ack
/block ack
/block ack request
, when it comes to agreements, mechanisms, procedures, policies, transfers, records, ...
In this MR, ht-configuration to yans-wifi-phy are covered, i.e. 90 files.
Edited by Rediet (Orange)