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=-2.5 required=3.0 tests=HEADER_FROM_DIFFERENT_DOMAINS, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED,USER_AGENT_MUTT 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 C7085C04AAC for ; Mon, 20 May 2019 18:42:58 +0000 (UTC) Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1 with cipher AES256-SHA (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id A4432204EC for ; Mon, 20 May 2019 18:42:58 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org A4432204EC 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 ([127.0.0.1]:40304 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1hSnFR-0006fI-EV for qemu-devel@archiver.kernel.org; Mon, 20 May 2019 14:42:57 -0400 Received: from eggs.gnu.org ([209.51.188.92]:51049) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1hSnEe-0006Fq-N7 for qemu-devel@nongnu.org; Mon, 20 May 2019 14:42:10 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1hSnEd-0003WA-BI for qemu-devel@nongnu.org; Mon, 20 May 2019 14:42:08 -0400 Received: from mx1.redhat.com ([209.132.183.28]:50542) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1hSnEd-0003CI-5V for qemu-devel@nongnu.org; Mon, 20 May 2019 14:42:07 -0400 Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.phx2.redhat.com [10.5.11.22]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 47CA330BB524; Mon, 20 May 2019 18:41:20 +0000 (UTC) Received: from localhost (ovpn-116-14.gru2.redhat.com [10.97.116.14]) by smtp.corp.redhat.com (Postfix) with ESMTP id DBB8C1001E86; Mon, 20 May 2019 18:41:11 +0000 (UTC) Date: Mon, 20 May 2019 15:41:08 -0300 From: Eduardo Habkost To: qemu-devel@nongnu.org, Gabriel Barreto Message-ID: <20190520184108.GA10764@habkost.net> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline User-Agent: Mutt/1.10.1 (2018-07-13) X-Scanned-By: MIMEDefang 2.84 on 10.5.11.22 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.49]); Mon, 20 May 2019 18:41:30 +0000 (UTC) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 209.132.183.28 Subject: [Qemu-devel] Introducing GSoC project: API Documentation Generation X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Peter Maydell , "Daniel P. Berrange" , "Emilio G. Cota" , Stefan Hajnoczi , Cleber Rosa , Paolo Bonzini , John Snow Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" Please welcome GSoC student Gabriel Barreto. Gabriel is going to work on QEMU API Documentation Generation[1]. Gabriel's first task is to evaluate our options for extract doc comments from C source code and integrate them into Sphinx documentation. I saw that Peter has experimented with kernel-doc in the past[2][3]. Has anybody evaluated other alternatives? (e.g. Hawkmoth[4]) [1] https://wiki.qemu.org/Google_Summer_of_Code_2019#API_documentation_generation [2] https://www.mail-archive.com/qemu-devel@nongnu.org/msg411643.html [3] https://www.mail-archive.com/qemu-devel@nongnu.org/msg411841.html [4] https://readthedocs.org/projects/hawkmoth/ -- Eduardo