Document domctl.h #98
Conversation
Deedone
force-pushed
the
docs
branch
2 times, most recently
from
d629e29 to
6b5fa4f
Compare
| @@ -12,27 +12,190 @@ | |||
|
|
|||
There was a problem hiding this comment.
You probably wanna add
- file header, like
/**
* @file
*
* @brief Public APIs for the I2C drivers.
*/
- interface header, like
/**
* @brief I2C Interface
* @defgroup i2c_interface I2C Interface
* @ingroup io_interfaces
* @{
*/
- interface footer
/**
* @}
*/
| * @brief Perform a scheduler operation on a specified domain. | ||
| * | ||
| * @param domid The ID of the domain on which the scheduler operation is to be performed. | ||
| * @param[in,out] sched_op A pointer to a `struct xen_domctl_scheduler_op` object that defines |
There was a problem hiding this comment.
Have you tried '@ref xen_domctl_scheduler_op' here?
Actually refs might be used in all APIs docs to reference Xen structures.
There was a problem hiding this comment.
Xen public headers do not use doxygen so there is nothing to ref to.
| int xen_domctl_scheduler_op(int domid, struct xen_domctl_scheduler_op *sched_op); | ||
| /** |
| * @param domid The domain ID of the domain to set the maximum memory for. | ||
| * @param max_memkb The maximum memory (in kilobytes) to set for the domain. | ||
| * @return 0 on success, or a negative error code on failure. | ||
| */ | ||
| int xen_domctl_max_mem(int domid, uint64_t max_memkb); |
There was a problem hiding this comment.
TODO: this api doesn't follow set/get naming convention
There was a problem hiding this comment.
Function names are chosen based on defines from Xen headers.
Deedone
force-pushed
the
docs
branch
2 times, most recently
from
7946325 to
6fdc816
Compare
include/zephyr/xen/dom0/domctl.h
Outdated
| * | ||
| * @brief Xen Domain Control Interface | ||
| */ | ||
|
|
There was a problem hiding this comment.
if you check other generic headers - "file header" is added as first block in the file or right after copyright block, can we follow the same, pls.
|
It seems to finish this task properly - the xen_xx.rst file need to be added in doc folder. It has to be similar to doc/hardware/peripherals/spi.rst (this one very simple) or doc/hardware/peripherals/i2c.rst (or any other interface doc). Question where to add these Xen doc files, with assumption that more docs will be added (event, ranges, gnt) - is "doc/hardware/peripherals" proper path? or need Xen specific folder somewhere? |
|
Let's try to keep PRs small and finally merge something because we keep getting interrelated changes piling up, and this is getting out of hand. |
The size is passed in bytes, not in megabytes. So rename the parameter to avoid confusion. Signed-off-by: Mykyta Poturai <[email protected]> Acked-by: Dmytro Firsov <[email protected]>
Document all of the public functions in the domctl API with doxygen Signed-off-by: Mykyta Poturai <[email protected]> Acked-by: Dmytro Firsov <[email protected]>
Document all of the public functions in the sysctl API with doxygen Signed-off-by: Mykyta Poturai <[email protected]> Acked-by: Dmytro Firsov <[email protected]>
|
LGTM. Thank you very much. |
Document all of the public functions in the domctl API with oxygen
Document all of the public functions in the sysctl API with doxygen
Fixes #97