From qdlacz@gmail.com Tue Sep 1 22:47:40 2009 Return-Path: X-Original-To: gtk-doc-list@gnome.org Delivered-To: gtk-doc-list@gnome.org Received: from localhost (localhost.localdomain [127.0.0.1]) by menubar.gnome.org (Postfix) with ESMTP id 0466B750102 for ; Tue, 1 Sep 2009 22:47:40 +0000 (GMT) X-Virus-Scanned: by amavisd-new at gnome.org X-Spam-Flag: NO X-Spam-Score: -1.903 X-Spam-Level: X-Spam-Status: No, score=-1.903 tagged_above=-999 required=2 tests=[BAYES_00=-2.599, RCVD_IN_SORBS_WEB=0.619, TW_GT=0.077] X-Amavis-OS-Fingerprint: Linux 2.6 (newer, 2) (up: 4489 hrs), (distance 14, link: ethernet/modem), [209.85.220.215] Received: from menubar.gnome.org ([127.0.0.1]) by localhost (menubar.gnome.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id j0yeirrQmm+E for ; Tue, 1 Sep 2009 22:47:34 +0000 (GMT) Received: from mail-fx0-f215.google.com (mail-fx0-f215.google.com [209.85.220.215]) by menubar.gnome.org (Postfix) with ESMTP id C92CB750093 for ; Tue, 1 Sep 2009 22:47:25 +0000 (GMT) Received: by fxm11 with SMTP id 11so407185fxm.15 for ; Tue, 01 Sep 2009 15:47:23 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=gamma; h=domainkey-signature:received:received:subject:from:to:content-type :date:message-id:mime-version:x-mailer:content-transfer-encoding; bh=LbfrRhr+CX499FBu53VdDbzFawot9gWA8ATUuT4IPmg=; b=IN5dYqWYknSI6luCcemD5EudsGI6Dbz4Rf6OEngqyozwG8XNVUnCZZVrPoLviaj6/4 NfdsfkPwID3PN7puFBhNCzkCsHGkhd4Xa0EbF+WNUfeCGKqfAF5xOv0WB/tfh9Go7B6/ kc6sEGRyVPUWdFklhyBI4PGvGoGTZzWQ/TAtA= DomainKey-Signature: a=rsa-sha1; c=nofws; d=gmail.com; s=gamma; h=subject:from:to:content-type:date:message-id:mime-version:x-mailer :content-transfer-encoding; b=vIvNy3jx+6yOhR0PpiFGDy98q+KqpmnVpdIL2pWr25qFVSeuuOGIxe2zEiW0GsITbU S6N7IcCmrRU9Lp+FZiw14CkNk4agh8vhdke6apl9uvDHUZwGKgMXjCQlTp83tMBxWS3f jl7eTdtcb+ILqfPguCMHZux4IoouQMhGpFuTI= Received: by 10.103.125.37 with SMTP id c37mr3227645mun.69.1251845243186; Tue, 01 Sep 2009 15:47:23 -0700 (PDT) Received: from ?192.168.1.102? (att215.neoplus.adsl.tpnet.pl [83.27.1.215]) by mx.google.com with ESMTPS id i5sm2823062mue.16.2009.09.01.15.47.20 (version=TLSv1/SSLv3 cipher=RC4-MD5); Tue, 01 Sep 2009 15:47:22 -0700 (PDT) Subject: Preferred way of putting title in section From: Krzesimir Nowak To: gtk-doc-list@gnome.org Content-Type: text/plain Date: Wed, 02 Sep 2009 00:46:56 +0200 Message-Id: <1251845217.13929.6.camel@fiodor> Mime-Version: 1.0 X-Mailer: Evolution 2.26.3 (2.26.3-1.fc11) Content-Transfer-Encoding: 7bit X-BeenThere: gtk-doc-list@gnome.org X-Mailman-Version: 2.1.12 Precedence: list List-Id: The gtk-doc documentation tool List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 01 Sep 2009 22:47:40 -0000 Hi, which way of putting title of section is preferred? 1. `@title: my title' in SECTION comment in source code. 2. `my title in package-sections.txt. There is a FIXME in `Documenting section' in gtk-doc manual about this. It would be good to have it clarified. Thanks, Krzem From yeti@physics.muni.cz Wed Sep 2 07:17:35 2009 Return-Path: X-Original-To: gtk-doc-list@gnome.org Delivered-To: gtk-doc-list@gnome.org Received: from localhost (localhost.localdomain [127.0.0.1]) by menubar.gnome.org (Postfix) with ESMTP id E0F3D75023B for ; Wed, 2 Sep 2009 07:17:35 +0000 (GMT) X-Virus-Scanned: by amavisd-new at gnome.org X-Spam-Flag: NO X-Spam-Score: -4.497 X-Spam-Level: X-Spam-Status: No, score=-4.497 tagged_above=-999 required=2 tests=[AWL=1.948, BAYES_00=-2.599, RCVD_IN_DNSWL_MED=-4, TW_GT=0.077, TW_TK=0.077] X-Amavis-OS-Fingerprint: Linux 2.6 (newer, 3) (up: 7594 hrs), (distance 23, link: ethernet/modem), [147.251.4.40] Received: from menubar.gnome.org ([127.0.0.1]) by localhost (menubar.gnome.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id JsGXaAOQpKDz for ; Wed, 2 Sep 2009 07:17:28 +0000 (GMT) Received: from minas.ics.muni.cz (minas.ics.muni.cz [147.251.4.40]) by menubar.gnome.org (Postfix) with ESMTP id 61864750102 for ; Wed, 2 Sep 2009 07:17:20 +0000 (GMT) Received: from monoceros.physics.muni.cz (postfix@monoceros.physics.muni.cz [147.251.27.2]) by minas.ics.muni.cz (8.13.8/8.13.8/SuSE Linux 0.8) with ESMTP id n827HGqK005310; Wed, 2 Sep 2009 09:17:17 +0200 Received: by monoceros.physics.muni.cz (Postfix, from userid 16809) id 8F93EC1B819; Wed, 2 Sep 2009 09:17:16 +0200 (CEST) Date: Wed, 2 Sep 2009 09:17:16 +0200 From: David =?utf-8?B?TmXEjWFz?= To: Krzesimir Nowak Subject: Re: Preferred way of putting title in section Message-ID: <20090902071716.GD3533@physics.muni.cz> References: <1251845217.13929.6.camel@fiodor> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <1251845217.13929.6.camel@fiodor> User-Agent: Mutt/1.5.18 (2008-05-17) X-Muni-Spam-TestIP: 147.251.27.2 X-Muni-Envelope-From: yeti@physics.muni.cz X-Muni-Virus-Test: Clean X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-3.0 (minas.ics.muni.cz [147.251.4.35]); Wed, 02 Sep 2009 09:17:17 +0200 (CEST) Cc: gtk-doc-list@gnome.org X-BeenThere: gtk-doc-list@gnome.org X-Mailman-Version: 2.1.12 Precedence: list List-Id: The gtk-doc documentation tool List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 02 Sep 2009 07:17:36 -0000 On Wed, Sep 02, 2009 at 12:46:56AM +0200, Krzesimir Nowak wrote: > which way of putting title of section is preferred? > 1. `@title: my title' in SECTION comment in source code. > 2. `my title in package-sections.txt. > > There is a FIXME in `Documenting section' in gtk-doc manual about this. > It would be good to have it clarified. The former because package-sections.txt can be (and should be) generated nowadays with gtkdoc-scan --rebuild-sections if you have sanely organized header files. Yeti