Messages in this thread | | | Date | Tue, 19 May 2015 09:56:50 +0200 | From | Michael Wang <> | Subject | Re: [PATCH RFC v2] Documentation/infiniband: Add docs for rdma-helpers |
| |
On 05/18/2015 06:58 PM, Doug Ledford wrote: [snip] >> I see :-) I've not work with the kdoc yet, not sure if there is any >> guidelines on how to write the header of inline func for kdoc? > > It's an automated tool thing. Any comment section that starts with /** > is automatically included as a kdoc. Then there is an expected format > after that. See Documentation/kernel-doc-nano-HOWTO.txt.
Got it :-)
> >>> >>> Just because I want to move this along versus waiting for another >>> respin, I'm going to copy and paste these into those locations and clean >>> up the changelog when I integrate this patch. >> >> Got it, if there is anything I could help, please let me know ;-) > > I'm sending the patch for review, please let me know if you are OK with > how I handled the attribution.
The definition is far more detailed and accurate, it's already good enough according to my understanding, should benefit the developer a lot ;-)
Regards, Michael Wang
>
| |