On 3.07.2018 19:21, Steven Rostedt wrote:
This works to consolidate the functions kshark_load_data_records() with kshark_load_data_entries(). It adds some helper functions for the two to use to simplify the code. Note, doxygen warns that struct rec_list is not documented. Really? Such a simple structure doesn't really require documentation. Is there a way to shut it up? Or I can just add code to say /** Shut doxygen up! ;-)
Yes, you can do
//! @cond Doxygen_Suppress
struct rec_list {
struct pevent_record *rec;
struct rec_list *next;
};
//! @endcond
Another solutions is to turn off all warnings. This can be done by adding
WARN_IF_UNDOCUMENTED = NO
to doc/dox_config
On the other hand, do we expect the normal users to build doxygen
documentation, if this documentation is available at
http://kernelshark.org? So maybe we can tolerate having some warnings.
Actually this reminds me that there is a third solution. We can make this warnings invisible for the normal users by redirecting the doxygen's stderr to a file.
What do you think? Yordan
Yordan, please review these.
Steven Rostedt (VMware) (3):
kernel-shark-qt: Move declarations to top in datafilter.c example
kernel-shark-qt: Consolidate load_data_entries and load_data_records
kernel-shark-qt: Add helper function to find the next_cpu in kshark_load_data_*()
----
kernel-shark-qt/examples/datafilter.c | 5 +-
kernel-shark-qt/src/libkshark.c | 253 ++++++++++++++++++++--------------
2 files changed, 151 insertions(+), 107 deletions(-)
|