kernel-doc mishandles declarations split into lines

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Hi,

Apologies for the long CC list, wasn't sure who really feels like they
understand this script anymore ... Markus, I think you had a rewrite of
the script in python?

If you have something like this:

/**
 * struct something
 * @very_long_member_name: abcde
 */
struct something {
	struct this_is_a_very_long_struct_name_so_need_to_break_for_the
		very_long_member_name;
};

then kernel-doc will mishandle it:

$ ./scripts/kernel-doc -rst -internal /tmp/test.c
/tmp/test.c:9: warning: No description found for parameter 'this_is_a_very_long_struct_name_so_need_to_break_for_thevery_long_member_name'
/tmp/test.c:9: warning: Excess struct/union/enum/typedef member 'very_long_member_name' description in 'something'


.. c:type:: struct something


**Definition**

::

  struct something {
  };

**Members**



Clearly, the code that strips trailing and leading whitespace (in
process_proto_type) is a bit *too* eager to do so, but so far I haven't
found anything that makes it work.

Anyone have any thoughts?

johannes
--
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



[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux