New issue
Advanced search Search tips
Note: Color blocks (like or ) mean that a user may not be available. Tooltip shows the reason.

Issue 637000 link

Starred by 1 user

Issue metadata

Status: Assigned
Owner:
Last visit > 30 days ago
Cc:
Components:
EstimatedDays: ----
NextAction: ----
OS: Chrome
Pri: 1
Type: Bug



Sign in to add a comment

EC: cleanup: ble: Add some basic documentation and function headers.

Project Member Reported by aaboagye@chromium.org, Aug 11 2016

Issue description

A lot of the new bluetooth stack code that was recently checked in, is missing some basic documentation.

It'd be nice to adhere to the previous status quo of adding in some basic doxygen-style headers for functions and things.

Right now, I see a lot of code that looks like this:

For example, in include/bluetooth_le.h:

/* BLE 4.1 Vol 6 2.3.3.1 */
void fill_remapping_table(struct remapping_table *rt, uint8_t map[5],
	int hop_increment);

void ble_tx(struct ble_pdu *pdu);

int ble_rx(struct ble_pdu *pdu, int timeout, int adv);

int ble_radio_init(uint32_t access_address, uint32_t crc_init_val);


Adding some basic headers would be nice; especially for newcomers to the code.
 

Sign in to add a comment