From patchwork Tue Jan 8 13:21:04 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Kieran Bingham X-Patchwork-Id: 175 Return-Path: Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 3982B60B21 for ; Tue, 8 Jan 2019 14:21:13 +0100 (CET) Received: from localhost.localdomain (cpc89242-aztw30-2-0-cust488.18-1.cable.virginm.net [86.31.129.233]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id B09A0586; Tue, 8 Jan 2019 14:21:12 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1546953672; bh=vVX57qQNcinRz6edTmnQ6u4mXpBvozOqxO7KhpAXsWI=; h=From:To:Cc:Subject:Date:From; b=tbbXOlwLf+EBYq2zi7LERJW7CRxzJyHbZlQ3b7WYV9waNzs5zBwhu9o2nkV0WDKdj p6wJy+ic2JDRt/nb/U+tmG0dsSz4/jaiLTUKen+XQG+dWbM1ZhpdZ865kEQwL/M510 Plo9QOXONwLpWIUm52U+JAhJ98fhACOPCx6doj60= From: Kieran Bingham To: LibCamera Devel Date: Tue, 8 Jan 2019 13:21:04 +0000 Message-Id: <20190108132106.24906-1-kieran.bingham@ideasonboard.com> X-Mailer: git-send-email 2.17.1 Subject: [libcamera-devel] [PATCH 0/2] Documentation: Quieten Doxygen X-BeenThere: libcamera-devel@lists.libcamera.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 08 Jan 2019 13:21:13 -0000 Presently Doxygen produces a lot of verbose output for all the files it processes. This means that any warnings and errors are quite obfuscated against the noise. Set the Doxygen option QUIET to 'yes' which removes all output except for warnings and errors. I don't think we are yet keen on making Doxygen warnings build failure errors though ? The second patch is optional and certainly deserves some discussion. Enabling parameter documentation warnings brings in a few extra across pipeline/vimc.cpp, camera_manager.h, device_enumerator.h, log.h, media_object.h, and pipeline_handler.h. Should we enable this option and fixup these extra warning levels? Kieran Bingham (2): Documentation: Suppress normal doxygen output [RFC] Documentation: Enable parameter documentation warnings Documentation/Doxyfile.in | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)