On Tue, 31 Jul 2018 16:50:47 +0300 "Yordan Karadzhov (VMware)" <y.karadz@xxxxxxxxx> wrote: > Hi Steven, > > On 13.07.2018 02:33, Steven Rostedt wrote: > > On a styling point. I realized that reading the doxygen output I find > > more difficult than kerneldoc. But then I realized it can be better if > > we add spacing. By putting in a blank comment line after @brief, and > > after the last @param, I think it is easier to read. For example: > > > > > >> + * @brief Allocate and process data collection, defined with a given Matching > >> + * condition function and value. Add this collection to the list of > >> + * collections used by the session. > > + * > >> + * @param kshark_ctx: Input location for the session context pointer. > >> + * @param data: Input location for the trace data. > >> + * @param n_rows: The size of the inputted data. > >> + * @param cond: Matching condition function for the collection to be > >> + * registered. > >> + * @param val: Matching condition value of for collection to be registered. > >> + * @param margin: The size of the additional (margin) data which do not > >> + * satisfying the data condition, but is added at the beginning > >> + * and at the end of each interval of the collection. If "0", > >> + * no margin data is added. > >> + * > >> + * @returns Pointer to the registered Data collections on success, or NULL > >> + * on failure. > >> + */ > > What do you think? > > > Do you mean that it makes it easy to read in the source file? > I can make this change in a separate patch. > Yes, thanks! -- Steve
|