michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doxygen: make device and init comments doxygen friendly

Browse source 
Document structs and some typo fixes

Change-Id: Idf9df3f4f401d141a2332a83c2c60cb19c9fb8e3
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
Anas Nashif 2015-07-10 14:52:53 -04:00
commit 538cb82151
2 changed files with 16 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

26
include/device.h
View file

@ -60,26 +60,28 @@
struct device; struct device;
/* Static device infomation (In ROM) Per driver instance */ /**
* @brief Static device information (In ROM) Per driver instance
* @param name name of the device
* @param init init function for the driver
* @param config_info address of driver instance config information
*/
struct device_config { struct device_config {
/** name of the device */
char *name; char *name;
/** init function for the driver */
int (*init)(struct device *device); int (*init)(struct device *device);
/** address of driver instance config information */
void *config_info; void *config_info;
}; };
/* Runtime device structure (In memory) Per driver instance */ /**
struct device { * @brief Runtime device structure (In memory) Per driver instance
/** Build time config information */ * @param device_config Build time config information
struct device_config *config; * @param driver_api pointer to structure containing the API unctions for
/** pointer to structure containing the API functions for the * the device type. This pointer is filled in by the driver at init time.
* device type. This pointer is filled in by the driver at * @param driver_data river instance data. For driver use only
* init time.
*/ */
struct device {
struct device_config *config;
void *driver_api; void *driver_api;
/** Driver instance data. For driver use only*/
void *driver_data; void *driver_data;
}; };

4
include/init.h
View file

@ -46,8 +46,8 @@
* *
* @brief Define an init object * @brief Define an init object
* *
* @details This macro declares an init object to be placed a * @details This macro declares an init object to be placed in a
* given init level section in the image. This macro not should be used * given init level section in the image. This macro should not be used
* directly. * directly.
* *
* @param cfg_name Name of the config object created with * @param cfg_name Name of the config object created with