| Message ID | 20200910221526.10041-5-ehabkost@redhat.com |
|---|---|
| State | New |
| Headers | show
Return-Path: <SRS0=7f1Q=CT=nongnu.org=qemu-devel-bounces+qemu-devel=archiver.kernel.org@kernel.org> 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=-9.6 required=3.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED, HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_PATCH, MAILING_LIST_MULTI, SIGNED_OFF_BY, 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 C05DCC433E2 for <qemu-devel@archiver.kernel.org>; Thu, 10 Sep 2020 22:20:02 +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 33F95208E4 for <qemu-devel@archiver.kernel.org>; Thu, 10 Sep 2020 22:20:02 +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="Cnc8eE1b" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 33F95208E4 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]:53728 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from <qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org>) id 1kGUvB-0007iJ-6K for qemu-devel@archiver.kernel.org; Thu, 10 Sep 2020 18:20:01 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:58640) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from <ehabkost@redhat.com>) id 1kGUqx-0001Vn-44 for qemu-devel@nongnu.org; Thu, 10 Sep 2020 18:15:39 -0400 Received: from us-smtp-2.mimecast.com ([207.211.31.81]:38411 helo=us-smtp-1.mimecast.com) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_CBC_SHA1:256) (Exim 4.90_1) (envelope-from <ehabkost@redhat.com>) id 1kGUqv-0002YV-GD for qemu-devel@nongnu.org; Thu, 10 Sep 2020 18:15:38 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1599776136; 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: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=4b6Sl8gKu7Y6j7Vbe64mIkWlAGphqX+tesIHdB1ai9M=; b=Cnc8eE1bkNo1X8JyU4iCrm63U/xs3wOB401D5Zmd3338Gooc174jjS+hzJYF1RPLjN+KoJ A9gn/gLtpTpibUt//OtLkwyml/ojOel25ywk2PkdcPf6w6pJCWnlEQ0fPqSru7X6SlZ3ju OZEZNEdQJh9tWvLAg6dT3eC6CmulJ/E= 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-15-pCzOknzwOZ2vEwD5EK8D5A-1; Thu, 10 Sep 2020 18:15:34 -0400 X-MC-Unique: pCzOknzwOZ2vEwD5EK8D5A-1 Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.phx2.redhat.com [10.5.11.15]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 3C663802B78; Thu, 10 Sep 2020 22:15:33 +0000 (UTC) Received: from localhost (ovpn-66-226.rdu2.redhat.com [10.10.66.226]) by smtp.corp.redhat.com (Postfix) with ESMTP id 058D67512C; Thu, 10 Sep 2020 22:15:32 +0000 (UTC) From: Eduardo Habkost <ehabkost@redhat.com> To: qemu-devel@nongnu.org Subject: [PATCH 4/9] qom: Add kernel-doc markup to introduction doc comment Date: Thu, 10 Sep 2020 18:15:21 -0400 Message-Id: <20200910221526.10041-5-ehabkost@redhat.com> In-Reply-To: <20200910221526.10041-1-ehabkost@redhat.com> References: <20200910221526.10041-1-ehabkost@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.15 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=ehabkost@redhat.com X-Mimecast-Spam-Score: 0.0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 8bit Received-SPF: pass client-ip=207.211.31.81; envelope-from=ehabkost@redhat.com; helo=us-smtp-1.mimecast.com X-detected-operating-system: by eggs.gnu.org: First seen = 2020/09/10 18:15:36 X-ACL-Warn: Detected OS = Linux 2.2.x-3.x [generic] [fuzzy] 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_H2=-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: <qemu-devel.nongnu.org> List-Unsubscribe: <https://lists.nongnu.org/mailman/options/qemu-devel>, <mailto:qemu-devel-request@nongnu.org?subject=unsubscribe> List-Archive: <https://lists.nongnu.org/archive/html/qemu-devel> List-Post: <mailto:qemu-devel@nongnu.org> List-Help: <mailto:qemu-devel-request@nongnu.org?subject=help> List-Subscribe: <https://lists.nongnu.org/mailman/listinfo/qemu-devel>, <mailto:qemu-devel-request@nongnu.org?subject=subscribe> Cc: Paolo Bonzini <pbonzini@redhat.com>, =?utf-8?q?Daniel_P=2E_Berrang?= =?utf-8?b?w6k=?= <berrange@redhat.com>, Eduardo Habkost <ehabkost@redhat.com>, Peter Maydell <peter.maydell@linaro.org> Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" <qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org> |
| Series |
docs: Convert QOM documentation to kernel-doc + Sphinx
|
expand
|
diff --git a/include/qom/object.h b/include/qom/object.h index 4fb528d841..d2eecdf872 100644 --- a/include/qom/object.h +++ b/include/qom/object.h @@ -29,9 +29,7 @@ typedef struct InterfaceInfo InterfaceInfo; #define TYPE_OBJECT "object" /** - * SECTION:object.h - * @title:Base Object Type System - * @short_description: interfaces for creating new types and objects + * DOC: * * The QEMU Object Model provides a framework for registering user creatable * types and instantiating objects from those types. QOM provides the following
Add DOC: section keyword to introduction doc comment, so it will be rendered by kernel-doc. Signed-off-by: Eduardo Habkost <ehabkost@redhat.com> --- include/qom/object.h | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-)