Em Mon, 9 Oct 2017 07:19:06 -0300 Mauro Carvalho Chehab <mchehab@xxxxxxxxxxxxxxxx> escreveu: > That's the second part of my V4L2 kAPI documentation improvements. > It is meant to reduce the gap between the kAPI media headers > and documentation, at least with regards to kernel-doc markups. > > We should likely write more things at the ReST files under Documentation/ > to better describe some of those APIs (VB2 being likely the first candidate), > but at least let's be sure that all V4L2 bits have kernel-doc markups. Forgot to mention: This series, together with the part1 one is on this tree: https://git.linuxtv.org/mchehab/experimental.git/log/?h=v4l-docs-part2-v1 As I may not have time to address the remaining kAPI bits for a while, let me document what kAPIs at include/media main dir are still out of sync: - cec-pin.h: struct cec_pin; - cec.h: several structs; - media-device.h, media-devnode.h: a couple of defines; - rc-core.h: ancillary functions; - soc-camera.h, v4l2-clk.h, videobuf-*.h - probably not worth the efforts, as those are obsolete kAPI; - v4l2-common.h: print macros. IMHO, we should try to get rid of them, and use dev_foo() everywhere; - v4l2-fwnode.h: In this specific case, Sakari has a patch series addressing it, moving existing documentation from v4l2-fwnode.c; - v4l2-mem2mem.h: v4l2 ioctl helpers aren't documented; - videobuf2-*.h: This series contain several documentation improvements there for VB2 core and V4L2, with are the most important ones - as they're used by the drivers. The other headers are either undocumented or barely documented. PS.: It should be noticed that there are other files under include/media and inside their sub-directories that aren't part of the media kAPI, but are driver-specific stuff, like, for example, imx.h, vsp1.h and i2c/ subdir. Thanks, Mauro -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html
