Message ID | 20171202185153.552-1-sven@narfation.org (mailing list archive) |
---|---|
Headers |
Return-Path: <b.a.t.m.a.n-bounces@lists.open-mesh.org> X-Original-To: patchwork@open-mesh.org Delivered-To: patchwork@open-mesh.org Received: from open-mesh.org (localhost [IPv6:::1]) by open-mesh.org (Postfix) with ESMTP id AE13881446; Sat, 2 Dec 2017 19:53:09 +0100 (CET) Authentication-Results: open-mesh.org; dkim=fail reason="signature verification failed" (1024-bit key; unprotected) header.d=narfation.org header.i=@narfation.org header.b="IRkVhJlZ"; dkim-atps=neutral Received-SPF: Pass (mailfrom) identity=mailfrom; client-ip=2001:4d88:2000:7::2; helo=v3-1039.vlinux.de; envelope-from=sven@narfation.org; receiver=<UNKNOWN> Received: from v3-1039.vlinux.de (narfation.org [IPv6:2001:4d88:2000:7::2]) by open-mesh.org (Postfix) with ESMTPS id 1D47780A20 for <b.a.t.m.a.n@lists.open-mesh.org>; Sat, 2 Dec 2017 19:52:47 +0100 (CET) Received: from sven-desktop.home.narfation.org (p200300C593DF83F90000000000004065.dip0.t-ipconnect.de [IPv6:2003:c5:93df:83f9::4065]) by v3-1039.vlinux.de (Postfix) with ESMTPSA id A6FC11100D4; Sat, 2 Dec 2017 19:52:44 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=narfation.org; s=20121; t=1512240764; bh=TjMGShA71SgaBpe5LZ3lfI35sk0eLFY0f6Y2WfLY+2k=; h=From:To:Cc:Subject:Date:From; b=IRkVhJlZTQEYd87+JFD3AksY1ah1grn5x4PrzIN/daIkW9d5SZXuG1ulyYbgNmLu0 kAszntqibjhy6HGAmvDBbw05dzY8CC9+uJnh1HpYUnkqLmdjpvUg3Hb3A8TsvReSYR f66pioIgL4P/8QbXmaek41SH5PDv+2Kesx0kMaiE= From: Sven Eckelmann <sven@narfation.org> To: b.a.t.m.a.n@lists.open-mesh.org Date: Sat, 2 Dec 2017 19:51:45 +0100 Message-Id: <20171202185153.552-1-sven@narfation.org> X-Mailer: git-send-email 2.11.0 Subject: [B.A.T.M.A.N.] [PATCH 0/8] batman-adv: kernel-doc enhancements X-BeenThere: b.a.t.m.a.n@lists.open-mesh.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: The list for a Better Approach To Mobile Ad-hoc Networking <b.a.t.m.a.n.lists.open-mesh.org> List-Unsubscribe: <https://lists.open-mesh.org/mm/options/b.a.t.m.a.n>, <mailto:b.a.t.m.a.n-request@lists.open-mesh.org?subject=unsubscribe> List-Archive: <http://lists.open-mesh.org/pipermail/b.a.t.m.a.n/> List-Post: <mailto:b.a.t.m.a.n@lists.open-mesh.org> List-Help: <mailto:b.a.t.m.a.n-request@lists.open-mesh.org?subject=help> List-Subscribe: <https://lists.open-mesh.org/mm/listinfo/b.a.t.m.a.n>, <mailto:b.a.t.m.a.n-request@lists.open-mesh.org?subject=subscribe> Reply-To: The list for a Better Approach To Mobile Ad-hoc Networking <b.a.t.m.a.n@lists.open-mesh.org> Errors-To: b.a.t.m.a.n-bounces@lists.open-mesh.org Sender: "B.A.T.M.A.N" <b.a.t.m.a.n-bounces@lists.open-mesh.org> |
Series |
batman-adv: kernel-doc enhancements
|
|
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
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