PureData documentation tools
Project 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 "..."
- **on** *(optional)* - describe reaction on input data type. Data types:
- atom
- int
- float
- list
- symbol
- pointer
- any
- data - for additional data types
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 "..."
- **on** *(optional)* - describe reaction on input data type. Data types:
- atom
- int
- float
- list
- symbol
- pointer
- any
- data - for additional data types
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pddoc-0.4.4.tar.gz
(72.5 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
pddoc-0.4.4-py2-none-any.whl
(147.4 kB
view details)
File details
Details for the file pddoc-0.4.4.tar.gz.
File metadata
- Download URL: pddoc-0.4.4.tar.gz
- Upload date:
- Size: 72.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e4eac33e08a89f54c257957e40f4de8a4018aedbf351f861e6a7e73db31df6b0
|
|
| MD5 |
10710eb3df8d5bd85c38359967ad3f0b
|
|
| BLAKE2b-256 |
0c76af80f12b6c0ec19520d8e61e7afe6b8de153c2a38ca7f16b0ba13173896b
|
File details
Details for the file pddoc-0.4.4-py2-none-any.whl.
File metadata
- Download URL: pddoc-0.4.4-py2-none-any.whl
- Upload date:
- Size: 147.4 kB
- Tags: Python 2
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
735ad38ce7229e304966b13389d3197133bdf272826851181aaffb3348e8c881
|
|
| MD5 |
850214ed66356a88ee2fa13ac6ea264e
|
|
| BLAKE2b-256 |
8ec5441abbafdda770c0c5121b7fe7f90138800f45f0b1cfd9a420c3c5bb68f4
|