i2c: doxygen fixes for public header
i2c: doxygen fixes for public header

Adding in documentation for the return values of the I2C functions.

Change-Id: I89d4a6918f860a0ac34f6905e6f9bba77158f1ff
Signed-off-by: Dan Kalowsky <53619d3d3576bbac1c2d05ecd99970e469cb3398@intel.com>

kraj/zephyr,nashif/zephyr,ldts/zephyr,nashif/zephyr,bigdinotech/zephyr,fbsder/zephyr,pklazy/zephyr,punitvara/zephyr,zephyriot/zephyr,finikorg/zephyr,explora26/zephyr,aceofall/zephyr-iotos,erwango/zephyr,punitvara/zephyr,zephyrproject-rtos/zephyr,holtmann/zephyr,Vudentz/zephyr,coldnew/zephyr-project-fork,sharronliu/zephyr,fractalclone/zephyr-riscv,nashif/zephyr,32bitmicro/zephyr,tidyjiang8/zephyr-doc,zephyriot/zephyr,runchip/zephyr-cc3200,mbolivar/zephyr,fbsder/zephyr,bboozzoo/zephyr,explora26/zephyr,finikorg/zephyr,sharronliu/zephyr,mbolivar/zephyr,kraj/zephyr,kraj/zephyr,runchip/zephyr-cc3200,32bitmicro/zephyr,32bitmicro/zephyr,mirzak/zephyr-os,aceofall/zephyr-iotos,mirzak/zephyr-os,bigdinotech/zephyr,bboozzoo/zephyr,mbolivar/zephyr,Vudentz/zephyr,runchip/zephyr-cc3220,finikorg/zephyr,runchip/zephyr-cc3200,jamesonwilliams/zephyr-kernel,coldnew/zephyr-project-fork,explora26/zephyr,GiulianoFranchetto/zephyr,erwango/zephyr,32bitmicro/zephyr,holtmann/zephyr,GiulianoFranchetto/zephyr,rsalveti/zephyr,kraj/zephyr,GiulianoFranchetto/zephyr,nashif/zephyr,punitvara/zephyr,coldnew/zephyr-project-fork,sharronliu/zephyr,punitvara/zephyr,explora26/zephyr,coldnew/zephyr-project-fork,bigdinotech/zephyr,nashif/zephyr,mirzak/zephyr-os,mbolivar/zephyr,galak/zephyr,fractalclone/zephyr-riscv,ldts/zephyr,punitvara/zephyr,runchip/zephyr-cc3220,galak/zephyr,Vudentz/zephyr,jamesonwilliams/zephyr-kernel,pklazy/zephyr,zephyriot/zephyr,pklazy/zephyr,mirzak/zephyr-os,Vudentz/zephyr,rsalveti/zephyr,kraj/zephyr,32bitmicro/zephyr,ldts/zephyr,fractalclone/zephyr-riscv,zephyrproject-rtos/zephyr,runchip/zephyr-cc3220,jamesonwilliams/zephyr-kernel,jamesonwilliams/zephyr-kernel,tidyjiang8/zephyr-doc,bigdinotech/zephyr,runchip/zephyr-cc3200,galak/zephyr,bboozzoo/zephyr,GiulianoFranchetto/zephyr,mbolivar/zephyr,pklazy/zephyr,rsalveti/zephyr,zephyriot/zephyr,rsalveti/zephyr,Vudentz/zephyr,mirzak/zephyr-os,galak/zephyr,zephyrproject-rtos/zephyr,holtmann/zephyr,tidyjiang8/zephyr-doc,fractalclone/zephyr-riscv,runchip/zephyr-cc3220,tidyjiang8/zephyr-doc,fbsder/zephyr,ldts/zephyr,sharronliu/zephyr,sharronliu/zephyr,zephyrproject-rtos/zephyr,zephyriot/zephyr,erwango/zephyr,tidyjiang8/zephyr-doc,erwango/zephyr,fbsder/zephyr,jamesonwilliams/zephyr-kernel,runchip/zephyr-cc3200,holtmann/zephyr,fractalclone/zephyr-riscv,bboozzoo/zephyr,explora26/zephyr,erwango/zephyr,bboozzoo/zephyr,galak/zephyr,finikorg/zephyr,GiulianoFranchetto/zephyr,ldts/zephyr,rsalveti/zephyr,finikorg/zephyr,bigdinotech/zephyr,aceofall/zephyr-iotos,coldnew/zephyr-project-fork,runchip/zephyr-cc3220,aceofall/zephyr-iotos,zephyrproject-rtos/zephyr,aceofall/zephyr-iotos,pklazy/zephyr,Vudentz/zephyr,holtmann/zephyr,fbsder/zephyr