From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-8.6 required=3.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 26A6AC63697 for ; Thu, 19 Nov 2020 18:05:30 +0000 (UTC) Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 05B7F21D46 for ; Thu, 19 Nov 2020 18:05:28 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=fail reason="signature verification failed" (1024-bit key) header.d=redhat.com header.i=@redhat.com header.b="ZK3D0vFP" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 05B7F21D46 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=redhat.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Received: from localhost ([::1]:45684 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kfoJD-0006JY-IF for qemu-devel@archiver.kernel.org; Thu, 19 Nov 2020 13:05:27 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:51748) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kfoHm-0005rx-Lz for qemu-devel@nongnu.org; Thu, 19 Nov 2020 13:03:58 -0500 Received: from us-smtp-delivery-124.mimecast.com ([63.128.21.124]:34885) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_CBC_SHA1:256) (Exim 4.90_1) (envelope-from ) id 1kfoHj-0003w6-0t for qemu-devel@nongnu.org; Thu, 19 Nov 2020 13:03:58 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1605809033; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to:references:references; bh=D3OZoCQwdnb266+IU8Yw9F5GpvKMyNQLLZQlY/zTDYU=; b=ZK3D0vFPFaOz6Je0ZkZkkZTbC9o77ssdqWtSVrKvl/c7ujFiyFv6kAYCCrbeQaUVxMtByx hs4/65lv0LZJJRPUq2kaQj+1D3fihSe4m5ZvqiCQhvpNitNLphO27h8dLYjsQc5dM1IVs0 IuxyeNmriEDO2mOIVgdeeM/Wrte6Uzw= Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-90-AMZ7skQQNRSE1yxio7PsAQ-1; Thu, 19 Nov 2020 13:03:51 -0500 X-MC-Unique: AMZ7skQQNRSE1yxio7PsAQ-1 Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.phx2.redhat.com [10.5.11.16]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id E58B51005D51; Thu, 19 Nov 2020 18:03:50 +0000 (UTC) Received: from localhost (ovpn-115-101.rdu2.redhat.com [10.10.115.101]) by smtp.corp.redhat.com (Postfix) with ESMTP id 7893E5C1D5; Thu, 19 Nov 2020 18:03:50 +0000 (UTC) Date: Thu, 19 Nov 2020 13:03:49 -0500 From: Eduardo Habkost To: Markus Armbruster Subject: Re: [PATCH v2 1/8] qobject: Include API docs in docs/devel/qobject.html Message-ID: <20201119180349.GW1509407@habkost.net> References: <20201116224143.1284278-1-ehabkost@redhat.com> <20201116224143.1284278-2-ehabkost@redhat.com> <87wnyhd6wd.fsf@dusky.pond.sub.org> MIME-Version: 1.0 In-Reply-To: <87wnyhd6wd.fsf@dusky.pond.sub.org> X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=ehabkost@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset=utf-8 Content-Disposition: inline Received-SPF: pass client-ip=63.128.21.124; envelope-from=ehabkost@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.001, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Paolo Bonzini , Daniel =?utf-8?B?UC4gQmVycmFuZ8Op?= , qemu-devel@nongnu.org, Peter Maydell Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" CCing Peter, Sphinx documentation machinery maintainer. On Thu, Nov 19, 2020 at 10:37:22AM +0100, Markus Armbruster wrote: > Eduardo Habkost writes: > > > Render existing doc comments at docs/devel/qobject.html. > > > > Signed-off-by: Eduardo Habkost > > --- [...] > > /** > > - * qnum_destroy_obj(): Free all memory allocated by a > > - * QNum object > > + * qnum_destroy_obj(): Free all memory allocated by a QNum object > > + * > > + * @obj: QNum object to be destroyed > > */ > > void qnum_destroy_obj(QObject *obj) > > { > > Many lines of the form > > + * @foo: a foo I hate them too. > > One of my reasons to dislike GTK-Doc. Oh well, it's what we're using. It's not gtk-doc. It's kernel-doc who generates warnings if some parameters are not documented, and maybe we should silence them. -- Eduardo