doc: net: lwm2m: add LwM2M high-level API documentation

The LwM2M public APIs were never well documented.  Let's fix
that by adding the needed information to include/net/lwm2m.h

Fixes: zephyrproject-rtos#12958

Signed-off-by: Michael Scott <[email protected]>

Author: mike-scott