diff --git a/docbook/make-wsluarm.pl b/docbook/make-wsluarm.pl index 16b753a922..9aa957b18e 100755 --- a/docbook/make-wsluarm.pl +++ b/docbook/make-wsluarm.pl @@ -83,8 +83,6 @@ sub parse_desc_common { # (ie, followed by ), so we do this stuff to a temp @r # array and then copy the non-empty ones into the passed-in array @ret if ($#lines >= 0) { - # capitalize the first letter of the first line - $lines[0] = ucfirst($lines[0]); # for each double newline, break into separate para's for (my $idx=0; $idx <= $#lines; $idx++) { @@ -222,9 +220,9 @@ sub parse_attrib_desc { my $mode = shift; if ($mode) { - $mode =~ s/RO/ Retrieve only./; - $mode =~ s/WO/ Assign only./; - $mode =~ s/RW|WR/ Retrieve or assign./; + $mode =~ s/RO/Retrieve only./; + $mode =~ s/WO/Assign only./; + $mode =~ s/RW|WR/Retrieve or assign./; $r[++$#r] = "Mode: $mode\n\n"; } else { die "Attribute does not have a RO/WO/RW mode: '$s'\n"; diff --git a/epan/wslua/wslua_dumper.c b/epan/wslua/wslua_dumper.c index 31070daba7..7a91e3a298 100644 --- a/epan/wslua/wslua_dumper.c +++ b/epan/wslua/wslua_dumper.c @@ -343,7 +343,7 @@ WSLUA_METHOD Dumper_dump(lua_State* L) { */ #define WSLUA_ARG_Dumper_dump_TIMESTAMP 2 /* The absolute timestamp the packet will have. */ #define WSLUA_ARG_Dumper_dump_PSEUDOHEADER 3 /* The `PseudoHeader` to use. */ -#define WSLUA_ARG_Dumper_dump_BYTEARRAY 4 /* the data to be saved */ +#define WSLUA_ARG_Dumper_dump_BYTEARRAY 4 /* The data to be saved */ Dumper d = checkDumper(L,1); PseudoHeader ph; diff --git a/epan/wslua/wslua_file_handler.c b/epan/wslua/wslua_file_handler.c index 4b638d234f..f006d724ca 100644 --- a/epan/wslua/wslua_file_handler.c +++ b/epan/wslua/wslua_file_handler.c @@ -791,7 +791,7 @@ WSLUA_FUNCTION wslua_register_filehandler(lua_State* L) { /* Register the FileHandler into Wireshark/TShark, so they can read/write this new format. All functions and settings must be complete before calling this registration function. This function cannot be called inside the reading/writing callback functions. */ -#define WSLUA_ARG_register_filehandler_FILEHANDLER 1 /* the FileHandler object to be registered */ +#define WSLUA_ARG_register_filehandler_FILEHANDLER 1 /* The FileHandler object to be registered */ FileHandler fh = checkFileHandler(L,WSLUA_ARG_register_filehandler_FILEHANDLER); if (in_routine) @@ -875,7 +875,7 @@ wslua_deregister_filehandler_work(FileHandler fh) WSLUA_FUNCTION wslua_deregister_filehandler(lua_State* L) { /* Deregister the FileHandler from Wireshark/TShark, so it no longer gets used for reading/writing/display. This function cannot be called inside the reading/writing callback functions. */ -#define WSLUA_ARG_register_filehandler_FILEHANDLER 1 /* the FileHandler object to be deregistered */ +#define WSLUA_ARG_register_filehandler_FILEHANDLER 1 /* The FileHandler object to be deregistered */ FileHandler fh = checkFileHandler(L,WSLUA_ARG_register_filehandler_FILEHANDLER); if (in_routine) @@ -1053,7 +1053,7 @@ WSLUA_ATTRIBUTE_NAMED_NUMBER_GETTER(FileHandler,type,file_type); WSLUA_ATTRIBUTE_STRING_GETTER(FileHandler,extensions); WSLUA_ATTRIBUTE_STRING_SETTER(FileHandler,extensions,TRUE); -/* WSLUA_ATTRIBUTE FileHandler_writing_must_seek RW true if the ability to seek is required when writing +/* WSLUA_ATTRIBUTE FileHandler_writing_must_seek RW True if the ability to seek is required when writing this file format, else false. This will be checked by Wireshark when writing out to compressed @@ -1063,7 +1063,7 @@ WSLUA_ATTRIBUTE_STRING_SETTER(FileHandler,extensions,TRUE); WSLUA_ATTRIBUTE_NAMED_BOOLEAN_GETTER(FileHandler,writing_must_seek,finfo.writing_must_seek); WSLUA_ATTRIBUTE_NAMED_BOOLEAN_SETTER(FileHandler,writing_must_seek,finfo.writing_must_seek); -/* WSLUA_ATTRIBUTE FileHandler_writes_name_resolution RW true if the file format supports name resolution +/* WSLUA_ATTRIBUTE FileHandler_writes_name_resolution RW True if the file format supports name resolution records, else false. */ static inline struct supported_block_type * safe_cast_away_block_type_const(const struct supported_block_type *arg) @@ -1116,7 +1116,7 @@ WSLUA_ATTRIBUTE_SET(FileHandler,writes_name_resolution, { \ } \ }); -/* WSLUA_ATTRIBUTE FileHandler_supported_comment_types RW set to the bit-wise OR'ed number representing +/* WSLUA_ATTRIBUTE FileHandler_supported_comment_types RW Set to the bit-wise OR'ed number representing the type of comments the file writer supports writing, based on the numbers in the `wtap_comments` table. */ static inline struct supported_option_type * safe_cast_away_option_type_const(const struct supported_option_type *arg) diff --git a/epan/wslua/wslua_frame_info.c b/epan/wslua/wslua_frame_info.c index 330b4298f3..5eb28b69aa 100644 --- a/epan/wslua/wslua_frame_info.c +++ b/epan/wslua/wslua_frame_info.c @@ -105,7 +105,7 @@ static int FrameInfo__gc(lua_State* L) { return 0; } -/* WSLUA_ATTRIBUTE FrameInfo_comment RW table of comments in this frame. */ +/* WSLUA_ATTRIBUTE FrameInfo_comment RW Table of comments in this frame. */ static int FrameInfo_get_comment (lua_State* L) { FrameInfo fi = checkFrameInfo(L,1); #define FRAMEINFO_COMMENTS_TABLE 2 diff --git a/epan/wslua/wslua_pinfo.c b/epan/wslua/wslua_pinfo.c index bb3b99a2dc..71f5b9c19f 100644 --- a/epan/wslua/wslua_pinfo.c +++ b/epan/wslua/wslua_pinfo.c @@ -293,7 +293,7 @@ PINFO_ADDRESS_SETTER(src); PINFO_ADDRESS_GETTER(dst); PINFO_ADDRESS_SETTER(dst); -/* WSLUA_ATTRIBUTE Pinfo_p2p_dir RW direction of this Packet. (incoming / outgoing) */ +/* WSLUA_ATTRIBUTE Pinfo_p2p_dir RW Direction of this Packet. (incoming / outgoing) */ PINFO_NUMBER_GETTER(p2p_dir); PINFO_NUMBER_SETTER(p2p_dir,int); @@ -360,7 +360,7 @@ static int Pinfo_get_private(lua_State *L) { return 1; } -/* WSLUA_ATTRIBUTE Pinfo_hi RW higher Address of this Packet. */ +/* WSLUA_ATTRIBUTE Pinfo_hi RW Higher Address of this Packet. */ static int Pinfo_get_hi(lua_State *L) { Pinfo pinfo = checkPinfo(L,1); Address addr; @@ -376,7 +376,7 @@ static int Pinfo_get_hi(lua_State *L) { return 1; } -/* WSLUA_ATTRIBUTE Pinfo_lo RO lower Address of this Packet. */ +/* WSLUA_ATTRIBUTE Pinfo_lo RO Lower Address of this Packet. */ static int Pinfo_get_lo(lua_State *L) { Pinfo pinfo = checkPinfo(L,1); Address addr; @@ -392,7 +392,7 @@ static int Pinfo_get_lo(lua_State *L) { return 1; } -/* WSLUA_ATTRIBUTE Pinfo_conversation WO sets the packet conversation to the given Proto object. */ +/* WSLUA_ATTRIBUTE Pinfo_conversation WO Sets the packet conversation to the given Proto object. */ static int Pinfo_set_conversation(lua_State *L) { Pinfo pinfo = checkPinfo(L,1); Proto proto = checkProto(L,2); diff --git a/epan/wslua/wslua_proto.c b/epan/wslua/wslua_proto.c index e435a7f02f..58c4c987e2 100644 --- a/epan/wslua/wslua_proto.c +++ b/epan/wslua/wslua_proto.c @@ -166,7 +166,7 @@ static int Proto__tostring(lua_State* L) { WSLUA_FUNCTION wslua_register_postdissector(lua_State* L) { /* Make a <> protocol (with a dissector function) a post-dissector. It will be called for every frame after dissection. */ -#define WSLUA_ARG_register_postdissector_PROTO 1 /* the protocol to be used as post-dissector. */ +#define WSLUA_ARG_register_postdissector_PROTO 1 /* The protocol to be used as post-dissector. */ #define WSLUA_OPTARG_register_postdissector_ALLFIELDS 2 /* Whether to generate all fields. Note: This impacts performance (default=false). */ diff --git a/epan/wslua/wslua_proto_field.c b/epan/wslua/wslua_proto_field.c index 410372c5a9..494aa099fe 100644 --- a/epan/wslua/wslua_proto_field.c +++ b/epan/wslua/wslua_proto_field.c @@ -1110,7 +1110,7 @@ static int ProtoField_boolean(lua_State* L, enum ftenum type) { /* _WSLUA_CONSTRUCTOR_ ProtoField_bool Creates a <> for a boolean true/false value. */ /* WSLUA_ARG_ProtoField_bool_ABBR Abbreviated name of the field (the string used in filters). */ /* WSLUA_OPTARG_ProtoField_bool_NAME Actual name of the field (the string that appears in the tree). */ -/* WSLUA_OPTARG_ProtoField_bool_DISPLAY how wide the parent bitfield is (`base.NONE` is used for NULL-value). */ +/* WSLUA_OPTARG_ProtoField_bool_DISPLAY How wide the parent bitfield is (`base.NONE` is used for NULL-value). */ /* WSLUA_OPTARG_ProtoField_bool_VALUESTRING A table containing the text that corresponds to the values. */ /* WSLUA_OPTARG_ProtoField_bool_MASK Integer mask of this field. */ /* WSLUA_OPTARG_ProtoField_bool_DESC Description of the field. */