F5/unison
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

test, utils, visualizer: document missing functions and variables in scripts

Browse Source 
Silences warnings on Doxygen > 1.9.7.
This commit is contained in:
Gabriel Ferreira
2024-01-28 17:56:41 +00:00
parent 61750bbd89
commit 3ed75b7e9e
9 changed files with 88 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/visualizer/visualizer/core.py
View File

@@ -127,6 +127,10 @@ class Node(PyVizObject):
# highlighted property
## @var selected
# selected property
## @var on_enter_notify_event
# on_enter_notify_event function
## @var on_leave_notify_event
# on_leave_notify_event function
## signal emitted whenever a tooltip is about to be shown for the node
## the first signal parameter is a python list of strings, to which

13
src/visualizer/visualizer/ipython_view.py
View File

@@ -356,6 +356,19 @@ class ConsoleView(Gtk.TextView):
# color pattern
## @var line_start
# line start
## @var onKeyPress
# onKeyPress function
## @var _write
# _write function
## @var _showPrompt
# _showPrompt function
## @var _changeLine
# _changeLine function
## @var _showReturned
# _showReturned function
## @var prompt
# prompt function
"""
Specialized text view for console-like workflow.

20
src/visualizer/visualizer/plugins/interface_statistics.py
View File

@@ -117,6 +117,26 @@ class ShowInterfaceStatistics(InformationWindow):
# visualizer node
## @var table_model
# table model
## @var _response_cb
# _response_cb function
## @var COLUMN_INTERFACE
# COLUMN_INTERFACE constant
## @var COLUMN_TX_PACKETS
# COLUMN_TX_PACKETS constant
## @var COLUMN_TX_BYTES
# COLUMN_TX_BYTES constant
## @var COLUMN_TX_PACKET_RATE
# COLUMN_TX_PACKET_RATE constant
## @var COLUMN_TX_BIT_RATE
# COLUMN_TX_BIT_RATE constant
## @var COLUMN_RX_PACKETS
# COLUMN_RX_PACKETS constant
## @var COLUMN_RX_BYTES
# COLUMN_RX_BYTES constant
## @var COLUMN_RX_PACKET_RATE
# COLUMN_RX_PACKET_RATE constant
## @var COLUMN_RX_BIT_RATE
# COLUMN_RX_BIT_RATE constant
(
COLUMN_INTERFACE,
COLUMN_TX_PACKETS,

12
src/visualizer/visualizer/plugins/ipv4_routing_table.py
View File

@@ -16,16 +16,18 @@ class ShowIpv4RoutingTable(InformationWindow):
# node index
## @var table_model
# table model
## @var _response_cb
# _response_cb function
## @var COLUMN_DESTINATION
# column destination
# COLUMN_DESTINATION constant
## @var COLUMN_NEXT_HOP
# column hop
# COLUMN_NEXT_HOP constant
## @var COLUMN_INTERFACE
# column interface
# COLUMN_INTERFACE constant
## @var COLUMN_TYPE
# column type
# COLUMN_TYPE constant
## @var COLUMN_PRIO
# column priority
# COLUMN_PRIO constant
(
COLUMN_DESTINATION,
COLUMN_NEXT_HOP,

10
src/visualizer/visualizer/plugins/olsr.py
View File

@@ -16,6 +16,16 @@ class ShowOlsrRoutingTable(InformationWindow):
# node index
## @var table_model
# table model
## @var _response_cb
# _response_cb function
## @var COLUMN_DESTINATION
# COLUMN_DESTINATION constant
## @var COLUMN_NEXT_HOP
# COLUMN_NEXT_HOP constant
## @var COLUMN_INTERFACE
# COLUMN_INTERFACE constant
## @var COLUMN_NUM_HOPS
# COLUMN_NUM_HOPS constant
(
COLUMN_DESTINATION,
COLUMN_NEXT_HOP,

11
src/visualizer/visualizer/plugins/show_last_packets.py
View File

@@ -43,6 +43,9 @@ class ShowLastPackets(InformationWindow):
# AND button
## @var op_OR_button
# OR button
## @var _response_cb
# _response_cb function
class PacketList(Gtk.ScrolledWindow):
"""
PacketList class
@@ -50,6 +53,14 @@ class ShowLastPackets(InformationWindow):
## @var table_model
# table model
## @var COLUMN_TIME
# COLUMN_TIME constant
## @var COLUMN_INTERFACE
# COLUMN_INTERFACE constant
## @var COLUMN_SIZE
# COLUMN_SIZE constant
## @var COLUMN_CONTENTS
# COLUMN_CONTENTS constant
(
COLUMN_TIME,
COLUMN_INTERFACE,

20
utils/grid.py
View File

@@ -1388,7 +1388,17 @@ class GtkGraphicRenderer(gtk.DrawingArea):
## @var __height
# height
## @var __buffer_surface
# buffer surface
# __buffer_surface
## @var expose
# expose function
## @var size_allocate
# size_allocate function
## @var motion_notify
# motion_notify function
## @var button_press
# button_press function
## @var button_release
# button_release function
def __init__(self, data):
"""! Initializer
@param self this object
@@ -1638,6 +1648,14 @@ class MainWindow:
# render
## @var __dialog
# dialog
## @var __set_smaller_cb
# __set_smaller_cb function
## @var __set_bigger_cb
# __set_bigger_cb function
## @var __output_png_cb
# __output_png_cb function
## @var __dialog_response_cb
# __dialog_response_cb function
def __init__(self):
"""! Initializer
@param self this object

1
utils/python-unit-tests.py
View File

@@ -414,6 +414,7 @@ class TestSimulator(unittest.TestCase):
return None
"""
super().__init__()
## __python_owns__ flag indicates that Cppyy should not manage the lifetime of this variable
self.__python_owns__ = False # Let C++ destroy this on Simulator::Destroy
## Listen port for the server
self.port = port

3
utils/tests/test-ns3.py
View File

@@ -858,6 +858,7 @@ class NS3ConfigureTestCase(NS3BaseTestCase):
self.config_ok(return_code, stdout, stderr)
# If nothing went wrong, we should have more executables in the list after enabling the examples.
## ns3_executables
self.assertGreater(len(get_programs_list()), len(self.ns3_executables))
# Now we disabled them back.
@@ -909,6 +910,7 @@ class NS3ConfigureTestCase(NS3BaseTestCase):
# At this point we should have fewer modules
enabled_modules = get_enabled_modules()
## ns3_modules
self.assertLess(len(get_enabled_modules()), len(self.ns3_modules))
self.assertIn("ns3-network", enabled_modules)
self.assertIn("ns3-wifi", enabled_modules)
@@ -1032,6 +1034,7 @@ class NS3ConfigureTestCase(NS3BaseTestCase):
ns3rc_templates = {"python": ns3rc_python_template, "cmake": ns3rc_cmake_template}
def __init__(self, type_ns3rc):
## type contains the ns3rc variant type (deprecated python-based or current cmake-based)
self.type = type_ns3rc
def format(self, **args):