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

visualizer: fix doxygen warnings

Browse Source
This commit is contained in:
Tommaso Pecorella
2022-01-05 20:58:23 -06:00
parent 3d23f9ed09
commit ee6b3cb0af
13 changed files with 52 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
src/visualizer/model/pyviz.h
View File

@@ -210,10 +210,20 @@ public:
// Yes, I know, this is just a utility function, not really related to the class in any way.
/**
* Utility function - clips a line to a bounding box.
* \param [in] boundsX1 Bounding box, minimum X coord
* \param [in] boundsY1 Bounding box, minimum Y coord
* \param [in] boundsX2 Bounding box, maximum X coord
* \param [in] boundsY2 Bounding box, maximum Y coord
* \param [in,out] lineX1 Line, minimum X coord (any on input, clipped to the bounding box on output)
* \param [in,out] lineY1 Line, minimum Y coord (any on input, clipped to the bounding box on output)
* \param [in,out] lineX2 Line, maximum X coord (any on input, clipped to the bounding box on output)
* \param [in,out] lineY2 Line, maximum Y coord (any on input, clipped to the bounding box on output)
*/
// -#- @lineX1(direction=inout); @lineY1(direction=inout); @lineX2(direction=inout); @lineY2(direction=inout) -#-
static void LineClipping (double boundsX1, double boundsY1, double boundsX2, double boundsY2, double &lineX1, double &lineY1, double &lineX2, double &lineY2); ///< don't break this line or pybindgen will not be able to pick up the above annotation :(
static void LineClipping (double boundsX1, double boundsY1, double boundsX2, double boundsY2, double &lineX1, double &lineY1, double &lineX2, double &lineY2);
// Don't break the above line or pybindgen will not be able to pick up the above annotation :(
private:

5
src/visualizer/model/visual-simulator-impl.cc
View File

@@ -31,7 +31,10 @@ NS_OBJECT_ENSURE_REGISTERED (VisualSimulatorImpl);
namespace
{
/// Get an object factory configured to the default simulator implementation
/**
* Get an object factory configured to the default simulator implementation
* \return an object factory.
*/
ObjectFactory
GetDefaultSimulatorImplFactory ()
{

6
src/visualizer/model/visual-simulator-impl.h
View File

@@ -81,7 +81,11 @@ protected:
void NotifyConstructionCompleted (void);
private:
Ptr<SimulatorImpl> GetSim (); ///< get the simulator implementation
/**
* Get the simulator implementation
* \return a pointer to the simulator implementation
*/
Ptr<SimulatorImpl> GetSim ();
Ptr<SimulatorImpl> m_simulator; ///< the simulator implementation
ObjectFactory m_simulatorImplFactory; ///< simulator implementation factory

11
src/visualizer/visualizer/base.py
View File

@@ -16,9 +16,9 @@ PIXELS_PER_METER = 3.0 # pixels-per-meter, at 100% zoom level
## PyVizObject class
class PyVizObject(GObject.GObject):
## @var __gtype_name__
# global type name
## global type name
__gtype_name__ = "PyVizObject"
## Returns tooltip text string.
#
## @param tooltip: tooltip object.
@@ -47,11 +47,12 @@ class NetDeviceTraits(object):
## @var is_virtual
# is virtual
def __init__(self, is_wireless=None, is_virtual=False):
''' Initialize function.
"""!
Initialize function.
@param self The current class
@param is_wireless is wireless flag
@param is_virtual is virtual flag
'''
"""
assert is_virtual or is_wireless is not None
self.is_wireless = is_wireless
self.is_virtual = is_virtual

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

@@ -110,18 +110,19 @@ class Node(PyVizObject):
# selected property
## @var highlighted
# highlighted property
## @var __gsignals__
# 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 information can be appended
## 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
## information can be appended
__gsignals__ = {
'query-extra-tooltip-info': (GObject.SignalFlags.RUN_LAST, None, (object,)),
}
def __init__(self, visualizer, node_index):
""" Initialize function.
"""! Initialize function.
@param self The object pointer.
@param visualizer: visualizer object
@param node_index: node index
@param visualizer visualizer object
@param node_index node index
"""
super(Node, self).__init__()
@@ -524,7 +525,6 @@ class Channel(PyVizObject):
@param self: class object.
@param channel: channel.
@return none
"""
self.channel = channel
self.canvas_item = GooCanvas.CanvasEllipse(radius_x=30, radius_y=30,
@@ -576,7 +576,6 @@ class WiredLink(Link):
@param self: class object.
@param node1: class object.
@param node2: class object.
@return none
"""
assert isinstance(node1, Node)
assert isinstance(node2, (Node, Channel))
@@ -621,7 +620,6 @@ class SimulationThread(threading.Thread):
@param self: class object.
@param viz: class object.
@return none
"""
super(SimulationThread, self).__init__()
assert isinstance(viz, Visualizer)
@@ -689,8 +687,8 @@ class ShowTransmissionsMode(object):
# none
## @var SELECTED
# selected
## @var __slots__
# enumeration
## enumeration
__slots__ = []
ShowTransmissionsMode.ALL = ShowTransmissionsMode()
ShowTransmissionsMode.NONE = ShowTransmissionsMode()

1
src/visualizer/visualizer/hud.py
View File

@@ -25,7 +25,6 @@ class Axes(object):
@param self: this object
@param viz: visualization object
@return none
"""
self.viz = viz
self.color = 0x8080C0FF

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

@@ -84,7 +84,6 @@ class IterableIPShell:
@param cout: Console standard output.
@param cerr: Console standard error.
@param input_func: Replacement for builtin raw_input()
@return none
"""
io = IPython.utils.io
if input_func:
@@ -149,6 +148,7 @@ class IterableIPShell:
def __update_namespace(self):
"""!
Update self.IP namespace for autocompletion with sys.modules
@return none
"""
for k, v in list(sys.modules.items()):
if not '.' in k:
@@ -157,6 +157,7 @@ class IterableIPShell:
def execute(self):
"""!
Executes the current line provided by the shell object.
@return none
"""
self.history_level = 0
orig_stdout = sys.stdout

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

@@ -18,13 +18,12 @@ class StatisticsCollector(object):
## NetDevStats class
class NetDevStats(object):
## @var __slots__
# class members
## class members
__slots__ = ['rxPackets', 'rxBytes', 'txPackets', 'txBytes',
'rxPacketRate', 'rxBitRate', 'txPacketRate', 'txBitRate']
def __init__(self, visualizer):
"""
"""!
Collects interface statistics for all nodes.
@param self this object
@param visualizer visualizer object
@@ -123,7 +122,7 @@ class ShowInterfaceStatistics(InformationWindow):
) = range(9)
def __init__(self, visualizer, node_index, statistics_collector):
"""
"""!
Initializer.
@param self this object
@param visualizer the visualizer object

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

@@ -25,12 +25,11 @@ class ShowIpv4RoutingTable(InformationWindow):
) = range(5)
def __init__(self, visualizer, node_index):
"""
"""!
Initializer
@param self this object
@param visualizer visualizer object
@param node_index the node index
@return the statistics
"""
InformationWindow.__init__(self)
self.win = Gtk.Dialog(parent=visualizer.window,

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

@@ -32,7 +32,6 @@ class ShowOlsrRoutingTable(InformationWindow):
@param self this object
@param visualizer visualizer object
@param node_index the node index
@return none
"""
InformationWindow.__init__(self)
self.win = Gtk.Dialog(parent=visualizer.window,

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

@@ -95,7 +95,7 @@ class ShowLastPackets(InformationWindow):
def __init__(self, visualizer, node_index):
"""
"""!
Initializer
@param self this object
@param visualizer the visualizer object

1
src/visualizer/visualizer/plugins/wifi_intrastructure_link.py
View File

@@ -114,7 +114,6 @@ class WifiLinkMonitor(object):
"""! Initialize function.
@param self The object pointer.
@param dummy_viz A dummy visualizer
@return none
"""
self.access_points = {} # bssid -> node
self.stations = [] # list of (sta_netdevice, viz_node, wifi_link)

12
src/visualizer/visualizer/svgitem.py
View File

@@ -32,13 +32,13 @@ class SvgItem(GooCanvas.ItemSimple):
# maximum x
## @var bounds_y2
# maximum y
## @var __gproperties__
# setup our custom properties
## setup our custom properties
__gproperties__ = {
'x': (float, # property type
'X', # property nick name
'The x coordinate of a SVG image', # property description
-10e6, # property minimum value
-10e6, # property minimum value
10e6, # property maximum value
0, # property default value
GObject.PARAM_READWRITE), # property flags
@@ -69,9 +69,13 @@ class SvgItem(GooCanvas.ItemSimple):
}
def __init__(self, x, y, rsvg_handle, **kwargs):
"""
"""!
Initializer
@param self this object
@param x The x coordinate of a SVG image
@param y The y coordinate of a SVG image
@param rsvg_handle SVG handle
@param kwargs key-value arguments
"""
super(SvgItem, self).__init__(**kwargs)
assert isinstance(rsvg_handle, rsvg.Handle)