Re: Developer documentation

[Anders Broman <anders.broman () ericsson com>]

-----Original Message-----
From: wireshark-dev-bounces () wireshark org [mailto:wireshark-dev-bounces () wireshark org] On Behalf Of Teto
Sent: den 30 september 2011 15:36
Cc: Developer support list for Wireshark
Subject: Re: [Wireshark-dev] Developer documentation

> ok it works with command line "doxygen doxygen.cfg.in" from epan folder. I thought "doxygen.cfg.in" was included by 
> the >root doxygen.cfg without checking it. My bad.
>
> > Patches to build docs are welcome.
> What should the patch do ?
>
> Thanks a lot.

Well as you discovered the doxygen support is sketchy, the ultimate goal would be to be able to build
Documentation from the top dir with chapters on
 - epan
 - gtk
 - wiretap
 - AirPcap(?)
 - ?
If I remember correctly I wasn't to pleased with the structure of the result for epan either, quite possible
Functions and parameters are missing. The existing ones could do with better documentation and grouping.
So anything that improves the current state really.
Regards
Anders

On Fri, Sep 30, 2011 at 12:21 PM, Anders Broman <anders.broman () ericsson com> wrote:
> Hi,
> Try building doxygen from epan subdirectory. Patches to build docs are welcome.
> Regards
> Anders
>
> -----Original Message-----
> From: wireshark-dev-bounces () wireshark org 
> [mailto:wireshark-dev-bounces () wireshark org] On Behalf Of Teto
> Sent: den 30 september 2011 10:54
> To: Developer support list for Wireshark
> Subject: [Wireshark-dev] Developer documentation
>
> Hi,
>
> I am slowly advancing on my energywise plugin. I couldn't build a 
> detailed doxygen documentation proto_tree_add_item / 
> proto_tree_add_text
>
> In the generated doxygen documentation "modules" tab I have:
>    AirPcap definitions and data structures
>    AirPcap functions
>
> Did I miss something ? Could someone upload or send me his/her 
> documentation please. I would be more porficient then by looking at 
> proto.h
>
>
> Regards
> Matt
> ______________________________________________________________________
> _____ 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
___________________________________________________________________________
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
___________________________________________________________________________
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