ANNOUNCEMENT: Live Wireshark University & Allegro Packets online APAC Wireshark Training Session
July 17th, 2024 | 10:00am-11:55am SGT (UTC+8) | Online

Wireshark-dev: Re: [Wireshark-dev] compiling wsluarm docbook files

From: Ulf Lamping <ulf.lamping@xxxxxx>
Date: Fri, 20 Oct 2006 00:20:21 +0200
Jaap Keuter wrote:
Hi,

Maybe a stupid question, but why bury this deep down in the source tree
instead of with the other docbook stuff, so in a subdirectory under
docbook? Integrate the build in there should be simpler.
ACK.

Another question that comes to my mind (without having a look at the current lua docbook content):

Does it (in general terms) contains basic information or will it mostly contain an API description?

If it contains an API description, docbook is really not the way to go - it inherently get's outdated if the API involves in time - making it a maintenance nightmare. In this case using e.g. doxygen might be the way to go (don't know if doxygen works nicely together with lua), as the API description is included in the code comments (tends to update as the code enhances in time) - instead of a separate document source (which is virtually never updated and get's outdated pretty soon).


Anyway, what's missing in any case is a (maybe small) README in epan\wslua to what it's all about (maybe a few intro sentences and a link to the Wiki or whatever appropriate).

BTW: What's the state of the current wiki lua pages?

I've tried to get a small overview of the current state and got *really* confused - the current state of the documentation is the best way to get users *away* from using lua - but you're working on it ...

Regards, ULFL