aboutsummaryrefslogtreecommitdiffstats
path: root/docbook/make-wsluarm.pl
AgeCommit message (Collapse)AuthorFilesLines
2016-10-18wslua: fix errors in documentation, add notational conventionsPeter Wu1-12/+11
Improve example with better formatting, clarification comments and more common variable names. Extend make-wsluarm.pl to support arguments containing underscores. Fixes the description of dissect_tcp_pdus. Change TvbRange.tvb(tvb) into tvbrange:tvb() and ByteArray.tvb(name) into bytearray:tvb(name), these are really instance methods. Change-Id: I1e20ef46195dc6c06f9ac790d3432db283d21a5e Reviewed-on: https://code.wireshark.org/review/18226 Reviewed-by: Anders Broman <a.broman58@gmail.com>
2016-07-08When generating the LUA reference in AsciiDoc then say so.Jaap Keuter1-4/+4
Generating LUA documentation source for the developer guide says that it's generating XML, which it did before the switch to AsciiDoc. Fix this statement. Change-Id: Ib8625af84c74b5f6dc31c1e9e5ded80d9d7940ff Reviewed-on: https://code.wireshark.org/review/16320 Reviewed-by: Michael Mann <mmann78@netscape.net>
2015-07-12Lua: split up wslua files into class-based filesHadriel Kaplan1-11/+46
The size of some of the wslua source files has grown large, and it's hard to quickly find things. So split them up based on class name, as much as seems reasonable. Also have the make-wsluarm.pl Perl script handle this. Change-Id: Ib495ec5c2a4df90495c0a05504856288a0b09213 Reviewed-on: https://code.wireshark.org/review/9579 Petri-Dish: Hadriel Kaplan <hadrielk@yahoo.com> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Hadriel Kaplan <hadrielk@yahoo.com>
2015-01-23Fix some WsLua documentation errorsHadriel Kaplan1-1/+1
The format of the API chapter was a bit screwed up, as was the indentation level of attributes. Also, some functions introduced in 1.11.3 were not documented as being since that version. Change-Id: I7912488c6da5b5ae72933e4c5ce49f8fbf0b0e34 Reviewed-on: https://code.wireshark.org/review/6753 Reviewed-by: Hadriel Kaplan <hadrielk@yahoo.com> Petri-Dish: Hadriel Kaplan <hadrielk@yahoo.com> Reviewed-by: Anders Broman <a.broman58@gmail.com>
2014-11-09Convert the Lua reference to AsciiDoc.Gerald Combs1-136/+82
Move it to the Developer's Guide while we're here. Nudge the markup in epan/wslua where needed. Note that we should probably convert it to AsciiDoc (if we're going to keep it in the DG) or Doxygen. Change-Id: Ie175111043f98b7a37eeeb8d185a833d8e866f8b Reviewed-on: https://code.wireshark.org/review/5203 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-03-31Continue to remove $Id$ from top of fileAlexis La Goutte1-2/+0
(Using sed : sed -i '/^\# \$Id\$/,+1 d') (start with dash) Change-Id: Ia4b5a6c2302f6a531f6a86c1ec3a2f8205c8c2dd Reviewed-on: https://code.wireshark.org/review/881 Reviewed-by: Anders Broman <a.broman58@gmail.com>
2014-03-25Enhance Lua API doc generator and add more API infoHadriel Kaplan1-140/+409
This enhances the Lua API doc generator Perl script to handle meta-information in description comments, such as bold, italics, raw code, version info, etc. The supported markup and codes are documented in make-wsluarm.pl. It's not beautiful Perl code (I don't know Perl), and I'd rather do it using Lua, but I think keeping it Perl makes more sense in the long run. Change-Id: I477b3ebe770075dcea9ec52708e2d6fb5758d2f4 Reviewed-on: https://code.wireshark.org/review/802 Reviewed-by: Hadriel Kaplan <hadrielk@yahoo.com> Reviewed-by: Anders Broman <a.broman58@gmail.com>
2014-03-19Add capture file reader/writer support for Lua so scripts can implement new ↵Michael Mann1-0/+8
capture file formats. This enables a Lua script to implement a brand new capture file format reader/writer, so that for example one could write a script to read from vendor-specific "logs" of packets, and show them as normal packets in wireshark. Change-Id: Id394edfffa94529f39789844c382b7ab6cc2d814 Reviewed-on: https://code.wireshark.org/review/431 Reviewed-by: Hadriel Kaplan <hadrielk@yahoo.com> Reviewed-by: Michael Mann <mmann78@netscape.net> Reviewed-by: Anders Broman <a.broman58@gmail.com>
2014-02-05Fix wslua docs script to handle module names with digits, like Int64/UInt64Hadriel Kaplan1-1/+1
The fix in commit 28e028ddd5579c3d405b21523cdc2773c798e32f missed the module name, which was only grabbing alphabetic characters not numbers. This fixes that oversight. Change-Id: I65a87279024a81b33a8deb83b7a3573ea6eaf139 Reviewed-on: https://code.wireshark.org/review/117 Reviewed-by: Evan Huus <eapache@gmail.com> Tested-by: Evan Huus <eapache@gmail.com>
2014-02-04Fix wslua docs script to handle class names with digits, like Int64/UInt64Hadriel Kaplan1-7/+7
Change-Id: I555e4401828680cc8d6516b11af21d2ae5c0144d Reviewed-on: https://code.wireshark.org/review/99 Reviewed-by: Stig Bjørlykke <stig@bjorlykke.org> Tested-by: Stig Bjørlykke <stig@bjorlykke.org>
2014-01-31Fix for Bug-9709 Lua: class attribute descriptions in API docs don't say if ↵Hadriel Kaplan1-2/+9
an attribute is read/write/both. Also added some minor text to README.wslua for developers. Change-Id: I50b36f06710da6920ad98be6dde27d6091d91d54 Reviewed-on: https://code.wireshark.org/review/50 Reviewed-by: Stig Bjørlykke <stig@bjorlykke.org> Tested-by: Stig Bjørlykke <stig@bjorlykke.org>
2013-08-22Fixed building documentation for Lua classes and functions containing digits.Stig Bjørlykke1-2/+2
svn path=/trunk/; revision=51474
2012-06-28Update Free Software Foundation address.Jakub Zawadzki1-1/+1
(COPYING will be updated in next commit) svn path=/trunk/; revision=43536
2011-01-31Clean up the whitespace in script.Jaap Keuter1-97/+98
svn path=/trunk/; revision=35731
2010-02-10Die if we can't open the input or output filesJeff Morriss1-50/+50
svn path=/trunk/; revision=31856
2008-08-05luis.ontanon@gmail.com => luis@ontanon.orgLuis Ontanon1-1/+1
svn path=/trunk/; revision=25937
2007-07-21Migrate the wslua ref man into wsugLuis Ontanon1-24/+31
svn path=/trunk/; revision=22369
2007-01-27Fix DTD validation ( older dtds were happy with it :/ )Luis Ontanon1-12/+19
svn path=/trunk/; revision=20576
2007-01-26Trying to get the WS Lua Ref Man to build with the rest of the documentationLuis Ontanon1-0/+476
svn path=/trunk/; revision=20571
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-17 11:20:30 +0000