Further documentation updates.

This commit is contained in:
Mike Auty
2017-01-03 23:06:39 +00:00
parent 3da5512fbd
commit e596c6a1b7
2 changed files with 9 additions and 8 deletions
+4 -4
View File
@@ -169,12 +169,12 @@ class Template(validity.ValidityRoutines):
@property
def vol(self):
"""Returns a volatility information object, much like the :class:`ObjectInterface` provides"""
"""Returns a volatility information object, much like the :class:`~volatility.framework.interfaces.objects.ObjectInformation` provides"""
return ReadOnlyMapping(self._vol)
@property
def children(self):
"""The children of this template (such as member types, subtypes and base_types where they are relevant).
"""The children of this template (such as member types, sub-types and base-types where they are relevant).
Used to traverse the template tree.
"""
return []
@@ -193,12 +193,12 @@ class Template(validity.ValidityRoutines):
"""Replaces `old_child` with `new_child` in the list of children"""
def clone(self):
"""Returns a copy of the original Template as constructed (without update_vol having been called)"""
"""Returns a copy of the original Template as constructed (without `update_vol` additions having been made)"""
clone = self.__class__(**self._vol.parents.new_child())
return clone
def update_vol(self, **new_arguments):
"""Updates the keyword arguments with values that will not be carried across to clones"""
"""Updates the keyword arguments with values that will **not** be carried across to clones"""
self._vol.update(new_arguments)
def __getattr__(self, attr):
+5 -4
View File
@@ -16,9 +16,10 @@ class ObjectTemplate(interfaces.objects.Template, validity.ValidityRoutines):
This is effectively a method of currying, but adds more structure to avoid abuse.
It also allows inspection of information that should already be known:
* Type size
* Members, etc
etc.
* Type size
* Members
* etc
"""
def __init__(self, object_class = None, type_name = None, **arguments):
@@ -50,7 +51,7 @@ class ObjectTemplate(interfaces.objects.Template, validity.ValidityRoutines):
def __call__(self, context, object_info):
"""Constructs the object
Returns: an object adhereing to the Object interface
Returns: an object adhereing to the :class:`~volatility.framework.interfaces.objects.ObjectInterface`
"""
arguments = {}
arguments.update(self.vol)