views:

932

answers:

2

The ampoule project uses some tags in docstring, like the javadoc ones.

For example from pool.py line 86:

def start(self, ampChild=None):
    """
    Starts the ProcessPool with a given child protocol.

    @param ampChild: a L{ampoule.child.AMPChild} subclass.
    @type ampChild: L{ampoule.child.AMPChild} subclass
    """

What are these tags, which tool uses it.

+3  A: 

Markup for a documentation tool, probably epydoc.

S.Lott
Yes, they are explained in http://epydoc.sourceforge.net/manual-fields.html
Andrea Francia
+1  A: 

Just for fun I'll note that the Python standard library is using Sphinx/reStructuredText, whose info field lists are similar.

def start(self, ampChild=None):
    """Starts the ProcessPool with a given child protocol.

    :param ampChild: a :class:`ampoule.child.AMPChild` subclass.
    :type ampChild: :class:`ampoule.child.AMPChild` subclass
    """
cdleary
How many convection for the same programming language! Bad thing.
Andrea Francia
@Andrea Francia: Epydoc is very lightweight (nowhere near as powerful as reStructuredText) and was developed well before reStructuredText was adopted as a standard. They both have good reason for existing, though I'd recommend users go with reStructuredText from here forward.
cdleary