mbox series

[0/8] batman-adv: kernel-doc enhancements

Message ID 20171202185153.552-1-sven@narfation.org
Headers show
Series batman-adv: kernel-doc enhancements | expand

Message

Sven Eckelmann Dec. 2, 2017, 6:51 p.m. UTC
Hi,

more and more functions/struct/enums/... in batman-adv have at least some
brief documentation. But there were still some externally visible (as
"visible" in other source files) elements which completely missed any kind
of kernel-doc. Accoring to the kernel-doc dicumentation [1], having these
documented "properly" is currently a goal.

This patchset now tries to unify the formatting slightly and then add
more (brief) documentation to these elements.

Kind regards,
	Sven

[1] https://www.kernel.org/doc/html/v4.14/doc-guide/kernel-doc.html#recommendations

Sven Eckelmann (8):
  batman-adv: Add missing kernel-doc to packet.h
  batman-adv: Use parentheses in function kernel-doc
  batman-adv: Use inline kernel-doc for enum/struct
  batman-adv: Fix kernel-doc references to struct members
  batman-adv: Add kernel-doc to structs in headers
  batman-adv: Add kernel-doc to enums in headers
  batman-adv: Add kernel-doc to functions in headers
  batman-adv: Add kernel-doc to externally visible functions

 net/batman-adv/bat_algo.c              |   34 +-
 net/batman-adv/bat_iv_ogm.c            |  102 +-
 net/batman-adv/bat_v.c                 |   48 +-
 net/batman-adv/bat_v_elp.c             |   24 +-
 net/batman-adv/bat_v_ogm.c             |   34 +-
 net/batman-adv/bitarray.c              |    2 +-
 net/batman-adv/bitarray.h              |    9 +-
 net/batman-adv/bridge_loop_avoidance.c |  109 +-
 net/batman-adv/bridge_loop_avoidance.h |    4 +-
 net/batman-adv/debugfs.c               |   28 +-
 net/batman-adv/distributed-arp-table.c |   77 +-
 net/batman-adv/distributed-arp-table.h |    6 +-
 net/batman-adv/fragmentation.c         |   20 +-
 net/batman-adv/fragmentation.h         |    2 +-
 net/batman-adv/gateway_client.c        |   62 +-
 net/batman-adv/gateway_common.c        |   27 +-
 net/batman-adv/gateway_common.h        |    5 +-
 net/batman-adv/hard-interface.c        |   62 +-
 net/batman-adv/hard-interface.h        |   58 +-
 net/batman-adv/hash.c                  |   17 +-
 net/batman-adv/hash.h                  |   27 +-
 net/batman-adv/icmp_socket.c           |   13 +-
 net/batman-adv/log.c                   |   17 +
 net/batman-adv/log.h                   |   61 +-
 net/batman-adv/main.c                  |   47 +-
 net/batman-adv/main.h                  |  120 +-
 net/batman-adv/multicast.c             |   78 +-
 net/batman-adv/multicast.h             |   16 +-
 net/batman-adv/netlink.c               |   22 +-
 net/batman-adv/network-coding.c        |  120 +-
 net/batman-adv/originator.c            |  119 +-
 net/batman-adv/originator.h            |    9 +-
 net/batman-adv/packet.h                |   25 +-
 net/batman-adv/routing.c               |   53 +-
 net/batman-adv/send.c                  |   63 +-
 net/batman-adv/send.h                  |    4 +-
 net/batman-adv/soft-interface.c        |   61 +-
 net/batman-adv/sysfs.c                 |   52 +-
 net/batman-adv/sysfs.h                 |   13 +
 net/batman-adv/tp_meter.c              |   70 +-
 net/batman-adv/translation-table.c     |  226 ++--
 net/batman-adv/tvlv.c                  |   38 +-
 net/batman-adv/types.h                 | 1992 ++++++++++++++++++++++----------
 43 files changed, 2694 insertions(+), 1282 deletions(-)

Comments

Sven Eckelmann Dec. 6, 2017, 10:42 a.m. UTC | #1
On Samstag, 2. Dezember 2017 19:51:45 CET Sven Eckelmann wrote:
> Hi,
> 
> more and more functions/struct/enums/... in batman-adv have at least some
> brief documentation. But there were still some externally visible (as
> "visible" in other source files) elements which completely missed any kind
> of kernel-doc. Accoring to the kernel-doc dicumentation [1], having these
> documented "properly" is currently a goal.
> 
> This patchset now tries to unify the formatting slightly and then add
> more (brief) documentation to these elements.

Applied in cfcb3be43ef5..10e3e73a191b

Kind regards,
	Sven