bt2: add support for comp. class help
authorPhilippe Proulx <eeppeliteloop@gmail.com>
Wed, 8 Feb 2017 01:12:39 +0000 (20:12 -0500)
committerJérémie Galarneau <jeremie.galarneau@efficios.com>
Sun, 28 May 2017 16:57:37 +0000 (12:57 -0400)
commit40910fbb32dca4f294744894d04cda81d8eea104
tree3b57c07631583077fe2bbefecf0b13402a383753
parenta889b89f1be9211d3de2d1e50a26c366e772f3b3
bt2: add support for comp. class help

The description of a user component class is the first line of the
class's docstring; the help is everything else starting at line 3:

class MySink(bt2.UserSinkComponent):
    '''This is the description.

    This is the help.

    This too:

        * And this.
        * And also that.

    Voilà.
    '''

    def _consume(self):
        # ...

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
bindings/python/bt2/component.py
bindings/python/bt2/native_btcomponentclass.i
This page took 0.024988 seconds and 4 git commands to generate.