Re: Improving documentation for programming interfaces

From: Markus Elfring
Date: Fri Dec 20 2019 - 11:23:34 EST


>> Some functions allocate resources to which a pointer (or handle) is returned.
>> I would find it nice then if such a pointer would contain also the background
>> information by which functions the resource should usually be released.
>>
>> Can it become easier to determine such data?
â
> It's unclear to me what you are requesting/proposing?

I suggest to clarify combinations for object construction and proper resource release.


> Can you be a bit more concrete?

Further examples:
* kmalloc â kfree
* kobject_create â kobject_put
* device_register â put_device

Can preprocessor macros help to express any more relationships for similar function pairs?

Regards,
Markus