Home page logo
/

wireshark logo Wireshark mailing list archives

Re: Add -Wdocumentation
From: Alexis La Goutte <alexis.lagoutte () gmail com>
Date: Fri, 13 Dec 2013 14:51:31 +0100

Hi,

On Mon, Dec 9, 2013 at 5:58 PM, Bálint Réczey <balint () balintreczey hu>wrote:

2013/12/9 Joerg Mayer <jmayer () loplof de>:
On Fri, Dec 06, 2013 at 03:38:08PM +0100, Alexis La Goutte wrote:
I plan to add -Wdocumentation [1] by default to Wireshark (when build
with
Clang).
I have already fix in trunk the documentation.

The major issue to add -Wdocumentation is other library (like
glib/gtk...)
It is don't use doxygen and make a lot of error.

To fix this, i use pragma to disable error for glib.h or gtk using a
wrapper (like wsgcrypt.h)

I attach the patch for gtk.h (the patch for glib.h is to big (>500ko)...
because modified all dissector !)

It is ok for you ?

This solution looks like overkill to me (touching lots and lots of actual
source files). Isn't there a way to handle this (at least mostly) via the
build mechanisms

I agree with Joerg, I think this -Wdocumentation flag badly needs a
way of excluding headers in /usr/include and /usr/local/include .

I not found other solution, to don't include /usr/*/include...


An alternative solution could be running Doxygen  and processing its
result/output, and I think it would work, too.

Yes, but -Wdocumentation found some warning/error no found by Doxygen and
it is include to build system (no need to have doxygen and graphviz...)


I use just a wrapper (like libcrypt.h) !
___________________________________________________________________________
Sent via:    Wireshark-dev mailing list <wireshark-dev () wireshark org>
Archives:    http://www.wireshark.org/lists/wireshark-dev
Unsubscribe: https://wireshark.org/mailman/options/wireshark-dev
             mailto:wireshark-dev-request () wireshark org?subject=unsubscribe

  By Date           By Thread  

Current thread:
[ Nmap | Sec Tools | Mailing Lists | Site News | About/Contact | Advertising | Privacy ]
AlienVault