Improve documentation and ordering.

This commit is contained in:
Mike Auty
2017-08-11 19:29:37 +01:00
parent e434909e50
commit 2954d7433f
+12 -10
View File
@@ -105,10 +105,15 @@ class BaseSymbolTableInterface(validity.ValidityRoutines):
@property
def symbols(self):
"""Returns an iterator of the Symbols"""
"""Returns an iterator of the Symbol names"""
raise NotImplementedError("Abstract property symbols not implemented by subclass.")
# ## Required Symbol type functions
# ## Required Type functions
@property
def types(self):
"""Returns an iterator of the Symbol type names"""
raise NotImplementedError("Abstract property types not implemented by subclass.")
def get_type(self, name):
"""Resolves a symbol name into an object template
@@ -117,10 +122,12 @@ class BaseSymbolTableInterface(validity.ValidityRoutines):
"""
raise NotImplementedError("Abstract method get_type not implemented by subclass.")
# ## Required Symbol enumeration functions
@property
def types(self):
"""Returns an iterator of the Symbol types"""
raise NotImplementedError("Abstract property types not implemented by subclass.")
def enumerations(self):
"""Returns an iterator of the Enumeration names"""
raise NotImplementedError("Abstract property enumerations not implemented by subclass.")
# ## Native Type Handler
@@ -181,11 +188,6 @@ class BaseSymbolTableInterface(validity.ValidityRoutines):
if closest_symbol.address == offset:
yield closest_symbol.name
@property
def enumerations(self):
"""Returns an iterator of the Enumeration names"""
raise NotImplementedError("Abstract property enumerations not implemented by subclass.")
class SymbolTableInterface(BaseSymbolTableInterface, configuration.ConfigurableInterface):
"""Handles a table of symbols"""