class FieldDeclaration:
- """Field declaration class. Do not instantiate."""
+ """
+ Base class for concrete field declarations.
+
+ This class is not meant to be instantiated by the user.
+ """
def __init__(self):
raise NotImplementedError("FieldDeclaration cannot be instantiated")
@property
def name(self):
- """Return the name of a FieldDeclaration or None on error."""
+ """
+ Field's name, or ``None`` on error.
+ """
return self._name
@property
def type(self):
"""
- Return the FieldDeclaration's type. One of the entries in class
- CTFTypeId.
+ Field's type (one of :class:`CTFTypeId` constants).
"""
return nbt._bt_ctf_field_type(self._fd)
@property
def scope(self):
"""
- Return the FieldDeclaration's scope.
+ Field's scope (one of :class:`CTFScope` constants).
"""
return self._s