Metadata-Version: 1.1
Name: pddoc
Version: 0.5.1
Summary: PureData documentation tools
Home-page: https://github.com/uliss/pddoc
Author: Serge Poltavski
Author-email: serge.poltavski@gmail.com
License: GPLv3
Description: # PDDOC
        PureData documentation generator
        
        ## XML
        for generation *-help.pd files used **pddoc** format
        
        ### properties
        
        ```xml
        <properties>
            <property name="PROP" type="TYPE">description</property>
        </properties>
        ```
        
        - **name** (required)
        - **type** (required):
            - int
            - float
            - symbol
            - atom - int, float or symbol
            - list - list of atoms
            - alias - alias for other property
            - flag - property that is **True** when specified, otherwise **False**
        - **readonly**
        - **units** - value unit from list:
            - herz
            - kiloherz
            - decibell
            - millisecond
            - second
            - bpm
            - percent
        - **minvalue** - minimum allowed value
        - **maxvalue** - maximum allowed value
        - **default** - default value, if not specified
        - **enum** - comma separated list of allowed values
            ```xml 
            <property enum="A,B,C"/>
            ```
            
        ### inlets
        ```xml
        <inlets dynamic="true">
            <inlet type="TYPE" number="XXX">
                <xinfo on="symbol"></xinfo>
            </inlet>
        </inlets>
        ```
        
        - **dynamic** *(optional)* - if True, external has dynamic number of inlets, otherwise fixed.
        - **type** *(optional)* - inlet type:
            - control
            - audio
        - **number** *(optional)* - manually specified inlet number: number, or "n", or "n+1", or "n-1", or "..."
        - **on** *(optional)* - describe reaction on input data type. Data types:
            - atom
            - int
            - float
            - list
            - symbol
            - pointer
            - any
            - data - for additional data types
        
        
            
        
        
Keywords: puredata documentation
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Multimedia :: Sound/Audio
Classifier: Programming Language :: Python :: 3.3
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
