search

projectacrn / acrn-hypervisor

Project ACRN hypervisor
BSD 3-Clause "New" or "Revised" License
1.1k stars 506 forks source link

doc: Add Doxygen comments to vmmapi.h #6918

Open amyreye opened 2 years ago

amyreye commented 2 years ago

Add Doxygen comments to https://github.com/projectacrn/acrn-hypervisor/blob/master/devicemodel/include/vmmapi.h to help users know what the APIs do.

Work with @dbkinder to incorporate comments for lines 98-102 into https://github.com/projectacrn/acrn-hypervisor/blob/master/doc/developer-guides/hld/hld-devicemodel.rst.

NanlinXie commented 2 years ago

For example, "acrn_ioreq_create_client" was replaced by "vm_create_ioreq_client", need update:

  1. .c/.h source code
  2. doxgen configfile to generate API
  3. HLD link for these APIs