Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1753648AbbHFTNQ (ORCPT ); Thu, 6 Aug 2015 15:13:16 -0400 Received: from tex.lwn.net ([70.33.254.29]:59363 "EHLO vena.lwn.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751083AbbHFTNO (ORCPT ); Thu, 6 Aug 2015 15:13:14 -0400 Date: Thu, 6 Aug 2015 13:13:11 -0600 From: Jonathan Corbet To: Danilo Cesar Lemes de Paula Cc: linux-doc@vger.kernel.org, Randy Dunlap , Daniel Vetter , Laurent Pinchart , Herbert Xu , Stephan Mueller , Michal Marek , linux-kernel@vger.kernel.org, intel-gfx , dri-devel Subject: Re: [PATCH v2] scripts/kernel-doc Allow struct arguments documentation in struct body Message-ID: <20150806131311.4298138e@lwn.net> In-Reply-To: <1438689848-6386-1-git-send-email-danilo.cesar@collabora.co.uk> References: <20150804090412.GG24689@phenom.ffwll.local> <1438689848-6386-1-git-send-email-danilo.cesar@collabora.co.uk> Organization: LWN.net X-Mailer: Claws Mail 3.11.1 (GTK+ 2.24.28; x86_64-redhat-linux-gnu) MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 8bit Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Length: 694 Lines: 20 On Tue, 4 Aug 2015 09:04:08 -0300 Danilo Cesar Lemes de Paula wrote: > Describing arguments at top of a struct definition works fine > for small/medium size structs, but it definitely doesn't work well > for struct with a huge list of elements. > > Keeping the arguments list inside the struct body makes it easier > to maintain the documentation. OK, this change has been merged into the docs tree. Thanks, jon -- To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/