Commit 76fe47e4 authored by VIGNET Pierre's avatar VIGNET Pierre
Browse files

[gui] Fix typos; add doc

parent d569c8ce
......@@ -41,6 +41,15 @@
##
"""
Collection of widgets for properties checking
Classes:
- :class:`ChartChecker`: GUI interface for query checking
- :class:`QueryCheckingForm`: Main form of ChartChecker Window
- :class:`SolutionWindow`: Show solutions found by the solver
- :class:`PropertyVisitor`: Used to parse places in a start property and force
their use by the simulator
- :class:`InhibWindow`: Show inhibitors - Not used anymore
"""
from collections import defaultdict
import traceback
......@@ -65,7 +74,7 @@ LOGGER = cm.logger()
class ChartChecker(object):
"""Provides a gui interface for checking some queries"""
"""Provides a GUI interface for query checking"""
def __init__(self, emvc, reporter, parent=None):
self.__emvc = emvc # edit mvc - link with charter
......@@ -116,7 +125,7 @@ class ChartChecker(object):
class QueryCheckingForm(object):
"""Former class for occurence checking; Now general simple query checking
"""General simple query checking; used by ChartChecker
.. TODO::
Exemple example_model.bcx:
......@@ -879,6 +888,9 @@ class PropertyVisitor(object):
"""Translate a SigExpression (condition of a transition) into a set of nodes
that satisfy the condition.
Used to force the simulator to use nodes mentioned in a start property by
the user.
Non mandatory nodes (inhibitors) are not retained.
Activators can be accessed in the attribute 'nodes'
"""
......
......@@ -40,6 +40,13 @@
##
"""
Widget for displaying information on the elements of the model
CharterInfo: Contains 3 classes inheriting from :class:`Info`:
:class:`ModelInfo`
:class:`NodeInfo`
:class:`TransInfo`
"""
from __future__ import print_function
import gtk
......@@ -149,6 +156,8 @@ class CharterInfo(gtk.Frame):
class Info(object):
"""Abstract class
Implementing a "notes window" for metadata of transitions and nodes
Used by::
:class:`ModelInfo`
......@@ -171,7 +180,7 @@ class Info(object):
def display_note_window(self, title, note_text):
"""Display a window with the given text content
Used to display notes from the selected transitions and nodes.
Used to display notes from the selected transitions or nodes.
.. seealso: :class:`NodeInfo`, :class:`TransInfo`.
......
......@@ -182,8 +182,10 @@ class TextPage(gtk.Frame):
class BioSignalEditor:
"""
Biosignal simple editor - can load and save files
"""Biosignal simple editor - can load and save files
Used by the Charter to view/edit the constraints of a model.
@param on_leave: method to be used when quitting the editor
"""
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment