diff options
| author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2017-12-18 10:30:13 -0200 | 
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2017-12-21 13:41:46 -0700 | 
| commit | 8ad72163165265b686902c182c1b4a913e738a81 (patch) | |
| tree | bdff1072d4c1f13cb35e2411adb9a960871cc589 /net/lapb/lapb_timer.c | |
| parent | 7c9aa0157ef4b4cc28c98b08a971dc8344e64aab (diff) | |
scripts: kernel-doc: parse next structs/unions
There are several places within the Kernel tree with nested
structs/unions, like this one:
  struct ingenic_cgu_clk_info {
    const char *name;
    enum {
      CGU_CLK_NONE = 0,
      CGU_CLK_EXT = BIT(0),
      CGU_CLK_PLL = BIT(1),
      CGU_CLK_GATE = BIT(2),
      CGU_CLK_MUX = BIT(3),
      CGU_CLK_MUX_GLITCHFREE = BIT(4),
      CGU_CLK_DIV = BIT(5),
      CGU_CLK_FIXDIV = BIT(6),
      CGU_CLK_CUSTOM = BIT(7),
    } type;
    int parents[4];
    union {
      struct ingenic_cgu_pll_info pll;
      struct {
        struct ingenic_cgu_gate_info gate;
        struct ingenic_cgu_mux_info mux;
        struct ingenic_cgu_div_info div;
        struct ingenic_cgu_fixdiv_info fixdiv;
      };
      struct ingenic_cgu_custom_info custom;
    };
  };
Currently, such struct is documented as:
	**Definition**
	::
	struct ingenic_cgu_clk_info {
	    const char * name;
	};
	**Members**
	``name``
	  name of the clock
With is obvioulsy wrong. It also generates an error:
	drivers/clk/ingenic/cgu.h:169: warning: No description found for parameter 'enum'
However, there's nothing wrong with this kernel-doc markup: everything
is documented there.
It makes sense to document all fields there. So, add a
way for the core to parse those structs.
With this patch, all documented fields will properly generate
documentation.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'net/lapb/lapb_timer.c')
0 files changed, 0 insertions, 0 deletions
