esp-wifi: Improve API docs

[bjoernQ]

Now that we enable relevant features when building the docs we should improve the API documentation - all public items should have meaningful documentation