summaryrefslogtreecommitdiff
path: root/sphinx/domains/cpp.py
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2010-08-22 11:36:08 +0200
committerGeorg Brandl <georg@python.org>2010-08-22 11:36:08 +0200
commit5978c17aed477cc2bbab7eae86bb8b18367c426e (patch)
tree8a31a3695744a106791724453db559985f874c8e /sphinx/domains/cpp.py
parentf160503120e0f72ea8b70bb850c92b8023bb9f6e (diff)
downloadsphinx-5978c17aed477cc2bbab7eae86bb8b18367c426e.tar.gz
Docstring harmonization.
Diffstat (limited to 'sphinx/domains/cpp.py')
-rw-r--r--sphinx/domains/cpp.py25
1 files changed, 14 insertions, 11 deletions
diff --git a/sphinx/domains/cpp.py b/sphinx/domains/cpp.py
index 8df89459..a59b2b50 100644
--- a/sphinx/domains/cpp.py
+++ b/sphinx/domains/cpp.py
@@ -135,29 +135,31 @@ class DefExpr(object):
__hash__ = None
def clone(self):
- """Close a definition expression node"""
+ """Clone a definition expression node."""
return deepcopy(self)
def get_id(self):
- """Returns the id for the node"""
+ """Return the id for the node."""
return u''
def get_name(self):
- """Returns the name. Returns either `None` or a node with
- a name you might call :meth:`split_owner` on.
+ """Return the name.
+
+ Returns either `None` or a node with a name you might call
+ :meth:`split_owner` on.
"""
return None
def split_owner(self):
- """Nodes returned by :meth:`get_name` can split off their
- owning parent. This function returns the owner and the
- name as a tuple of two items. If a node does not support
- it, :exc:`NotImplementedError` is raised.
+ """Nodes returned by :meth:`get_name` can split off their owning parent.
+
+ This function returns the owner and the name as a tuple of two items.
+ If a node does not support it, :exc:`NotImplementedError` is raised.
"""
raise NotImplementedError()
def prefix(self, prefix):
- """Prefixes a name node (a node returned by :meth:`get_name`)."""
+ """Prefix a name node (a node returned by :meth:`get_name`)."""
raise NotImplementedError()
def __str__(self):
@@ -984,8 +986,9 @@ class CPPFunctionObject(CPPObject):
class CPPCurrentNamespace(Directive):
- """This directive is just to tell Sphinx that we're documenting
- stuff in namespace foo.
+ """
+ This directive is just to tell Sphinx that we're documenting stuff in
+ namespace foo.
"""
has_content = False