Patch Detail
Show a patch.
GET /api/1.1/patches/34/?format=api
{ "id": 34, "url": "https://patchwork.libcamera.org/api/1.1/patches/34/?format=api", "web_url": "https://patchwork.libcamera.org/patch/34/", "project": { "id": 1, "url": "https://patchwork.libcamera.org/api/1.1/projects/1/?format=api", "name": "libcamera", "link_name": "libcamera", "list_id": "libcamera_core", "list_email": "libcamera-devel@lists.libcamera.org", "web_url": "", "scm_url": "", "webscm_url": "" }, "msgid": "<20181211191011.6315-6-laurent.pinchart@ideasonboard.com>", "date": "2018-12-11T19:10:10", "name": "[libcamera-devel,5/6] libcamera: log: Fix Doxygen documentation", "commit_ref": null, "pull_url": null, "state": "accepted", "archived": false, "hash": "3ccaed9188b4b5e781b012bb303f3e61e7adeef1", "submitter": { "id": 2, "url": "https://patchwork.libcamera.org/api/1.1/people/2/?format=api", "name": "Laurent Pinchart", "email": "laurent.pinchart@ideasonboard.com" }, "delegate": null, "mbox": "https://patchwork.libcamera.org/patch/34/mbox/", "series": [ { "id": 16, "url": "https://patchwork.libcamera.org/api/1.1/series/16/?format=api", "web_url": "https://patchwork.libcamera.org/project/libcamera/list/?series=16", "date": "2018-12-11T19:10:05", "name": "Documentation: Initial Doxygen support", "version": 1, "mbox": "https://patchwork.libcamera.org/series/16/mbox/" } ], "comments": "https://patchwork.libcamera.org/api/patches/34/comments/", "check": "pending", "checks": "https://patchwork.libcamera.org/api/patches/34/checks/", "tags": {}, "headers": { "Return-Path": "<laurent.pinchart@ideasonboard.com>", "Received": [ "from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 31BFB60B0C\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tTue, 11 Dec 2018 20:09:45 +0100 (CET)", "from avalon.bb.dnainternet.fi\n\t(dfj612ybrt5fhg77mgycy-3.rev.dnainternet.fi\n\t[IPv6:2001:14ba:21f5:5b00:2e86:4862:ef6a:2804])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 4A04656E\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tTue, 11 Dec 2018 20:09:44 +0100 (CET)" ], "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1544555384;\n\tbh=WxB+3HWO3qhHDeuQEj3YiZH0f1AgYhB1vTn7n1fbFsU=;\n\th=From:To:Subject:Date:In-Reply-To:References:From;\n\tb=Jg1/Xhs6MKBx5XkdgkKymUlb5NEjp5chqdfMbx3DFTgmIdPFrHcB3tHlvBzR6VlF3\n\tMw1oTt10X+rhHz3xTIFkcCKcCm3S+3CnaO+CqTzhUjdl/jvtwpRW+0+6H7HwcjhyZe\n\tgt82tGFo62asOTFpWQNWI64ktR2ar4SO/ewo5TUI=", "From": "Laurent Pinchart <laurent.pinchart@ideasonboard.com>", "To": "libcamera-devel@lists.libcamera.org", "Date": "Tue, 11 Dec 2018 21:10:10 +0200", "Message-Id": "<20181211191011.6315-6-laurent.pinchart@ideasonboard.com>", "X-Mailer": "git-send-email 2.19.2", "In-Reply-To": "<20181211191011.6315-1-laurent.pinchart@ideasonboard.com>", "References": "<20181211191011.6315-1-laurent.pinchart@ideasonboard.com>", "MIME-Version": "1.0", "Content-Transfer-Encoding": "8bit", "Subject": "[libcamera-devel] [PATCH 5/6] libcamera: log: Fix Doxygen\n\tdocumentation", "X-BeenThere": "libcamera-devel@lists.libcamera.org", "X-Mailman-Version": "2.1.23", "Precedence": "list", "List-Id": "<libcamera-devel.lists.libcamera.org>", "List-Unsubscribe": "<https://lists.libcamera.org/options/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=unsubscribe>", "List-Archive": "<https://lists.libcamera.org/pipermail/libcamera-devel/>", "List-Post": "<mailto:libcamera-devel@lists.libcamera.org>", "List-Help": "<mailto:libcamera-devel-request@lists.libcamera.org?subject=help>", "List-Subscribe": "<https://lists.libcamera.org/listinfo/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=subscribe>", "X-List-Received-Date": "Tue, 11 Dec 2018 19:09:45 -0000" }, "content": "Now that the documentation can be compiled, Doxygen throws a few\nwarnings due to incorrect enum field naming. Fix it.\n\nThe \\file block needs to be named after the header file in order for\nDoxygen to document any global function, variable, typedef or enum\ndefined in the header (as documented in the Doxygen manual under the\n\\file command). We thus need to use log.h as the file name. No \\file\nblock is needed for the .cpp file, as we don't want to generate\ndocumentation for internal private globals.\n\nSigned-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\n---\n src/libcamera/log.cpp | 8 ++++----\n 1 file changed, 4 insertions(+), 4 deletions(-)", "diff": "diff --git a/src/libcamera/log.cpp b/src/libcamera/log.cpp\nindex 2a3824972c9a..c5345cf079a3 100644\n--- a/src/libcamera/log.cpp\n+++ b/src/libcamera/log.cpp\n@@ -14,7 +14,7 @@\n #include \"utils.h\"\n \n /**\n- * \\file log.cpp\n+ * \\file log.h\n * \\brief Logging infrastructure\n */\n \n@@ -23,11 +23,11 @@ namespace libcamera {\n /**\n * \\enum LogSeverity\n * Log message severity\n- * \\var Info\n+ * \\var LogInfo\n * Informational message\n- * \\var Warning\n+ * \\var LogWarning\n * Warning message, signals a potential issue\n- * \\var Error\n+ * \\var LogError\n * Error message, signals an unrecoverable issue\n */\n \n", "prefixes": [ "libcamera-devel", "5/6" ] }