Wireshark-dev: Re: [Wireshark-dev] Doxygen configuration (was Re: [Wireshark-commits] rev 49051

From: Evan Huus <eapache@xxxxxxxxx>
Date: Fri, 26 Apr 2013 22:24:38 -0400
On Fri, Apr 26, 2013 at 6:36 PM, Gerald Combs <gerald@xxxxxxxxxxxxx> wrote:
> It might make sense to remove the current dependencies and force it to
> rebuild each time. Unless we start building it by default you'd
> presumably want a freshly-built API reference each time you run "make
> wsar_html".

That would work I think.

> BTW, the API Reference is now available at
>
>   http://www.wireshark.org/docs/wsar_html/
>
> It's automatically updated by Buildbot. After reading through the
> Doxygen documentation it might make sense to get rid of the separate ui
> and epan configurations and instead create groups for each module. We
> also need to add wsutil and wiretap.

Very useful. I agree, some cleanup is in order, though I know next to
nothing about doxygen beyond @param and @return. If there's some way
to do subgroups/submodules of epan (wmem, dfilter, etc.) that would
also be useful.

P.S. The link is not accessible via https for some reason? I had to
disable HTTPS Everywhere to access it.

> On 4/26/13 11:43 AM, Evan Huus wrote:
>> The wsar_html target needs to depend on $(WIRESHARK_COMMON_INCLUDES)
>> or something of that sort so that it rebuilds when header files get
>> changed. I'm not sure what the appropriate variable is to use here, we
>> don't seem to have any one variable that lists *all* the header files?
>>
>> Evan
>>
>> On Fri, Apr 26, 2013 at 1:49 PM,  <gerald@xxxxxxxxxxxxx> wrote:
>>> http://anonsvn.wireshark.org/viewvc/viewvc.cgi?view=rev&revision=49051
>>>
>>> User: gerald
>>> Date: 2013/04/26 10:49 AM
>>>
>>> Log:
>>>  Add some Doxygen checks.
>>>
>>> Directory: /trunk/epan/
>>>   Changes    Path           Action
>>>   +2 -0      Makefile.am    Modified
>>>
>>> Directory: /trunk/
>>>   Changes    Path           Action
>>>   +4 -0      Makefile.am    Modified
>>>
>>> Directory: /trunk/ui/
>>>   Changes    Path           Action
>>>   +2 -0      Makefile.am    Modified
>>>
>>> ___________________________________________________________________________
>>> Sent via:    Wireshark-commits mailing list <wireshark-commits@xxxxxxxxxxxxx>
>>> Archives:    http://www.wireshark.org/lists/wireshark-commits
>>> Unsubscribe: https://wireshark.org/mailman/options/wireshark-commits
>>>              mailto:wireshark-commits-request@xxxxxxxxxxxxx?subject=unsubscribe
>> ___________________________________________________________________________
>> Sent via:    Wireshark-dev mailing list <wireshark-dev@xxxxxxxxxxxxx>
>> Archives:    http://www.wireshark.org/lists/wireshark-dev
>> Unsubscribe: https://wireshark.org/mailman/options/wireshark-dev
>>              mailto:wireshark-dev-request@xxxxxxxxxxxxx?subject=unsubscribe
>>
>
> ___________________________________________________________________________
> Sent via:    Wireshark-dev mailing list <wireshark-dev@xxxxxxxxxxxxx>
> Archives:    http://www.wireshark.org/lists/wireshark-dev
> Unsubscribe: https://wireshark.org/mailman/options/wireshark-dev
>              mailto:wireshark-dev-request@xxxxxxxxxxxxx?subject=unsubscribe